Weather - Get Tropical Storm Active
Gebruik om een lijst te krijgen van de actieve tropische stormen die zijn uitgegeven door nationale weersvoorspellingsbureaus.
De Get Tropical Storm Active API is een HTTP-verzoek GET dat een lijst retourneert van alle door de overheid uitgegeven actieve tropische stormen. Informatie over de tropische stormen omvat: overheids-ID, bekken-ID, jaar van herkomst, naam en of het subtropisch is.
GET {endpoint}/weather/tropical/storms/active/json?api-version=1.1
URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
De hostnaam van de Azure Maps-service. Gebruik |
|
format
|
path | True |
Gewenste indeling van het antwoord. Alleen |
|
|
api-version
|
query | True |
string minLength: 1 |
De API-versie die voor deze bewerking moet worden gebruikt. |
Aanvraagkoptekst
| Name | Vereist | Type | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Geeft het account aan dat bedoeld is voor gebruik met het Microsoft Entra ID-beveiligingsmodel. Deze unieke ID voor het Azure Maps-account kan worden verkregen via de Azure Maps beheerplane Account API. Voor meer informatie over het gebruik van Microsoft Entra ID beveiliging in Azure Maps, zie Beheer authenticatie in Azure Maps. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
De aanvraag is voltooid. |
|
| Other Status Codes |
Een onverwachte foutreactie. |
Beveiliging
AadToken
Dit zijn de Microsoft Entra OAuth 2.0 stromen. In combinatie met Azure rolgebaseerde toegang control kan het worden gebruikt om de toegang tot Azure Maps REST-API's te controleren. Azure rolgebaseerde toegangscontroles worden gebruikt om toegang aan een of meer Azure Maps-resourceaccounts of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.
Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.
Note
- Deze beveiligingsdefinitie vereist het gebruik van de
x-ms-client-id-header om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen uit de Maps Management API-. - De
Authorization URLis specifiek voor het exemplaar van de openbare Azure-cloud. Sovereign clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties. - Het op rollen gebaseerde toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
- Gebruik van de Azure Maps Web SDK maakt configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.
- Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Dit is een gedeelde sleutel die wordt ingericht wanneer u Een Azure Maps-account maken in Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.
Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze worden uitgegeven.
Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.
Type:
apiKey
In:
header
SAS Token
Dit is een shared access Signature-token dat wordt gemaakt op basis van de bewerking List SAS op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
Met dit token is elke toepassing gemachtigd voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.
Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.
Type:
apiKey
In:
header
Voorbeelden
Get Tropical Storm Active
Voorbeeldaanvraag
GET https://atlas.microsoft.com/weather/tropical/storms/active/json?api-version=1.1
Voorbeeldrespons
{
"results": [
{
"name": "Hilda",
"basinId": "EP",
"govId": 8,
"isActive": true,
"isSubtropical": false,
"year": "2021"
},
{
"name": "TD 9E",
"basinId": "EP",
"govId": 9,
"isActive": true,
"isSubtropical": false,
"year": "2021"
},
{
"name": "TWELVE",
"basinId": "NP",
"govId": 12,
"isActive": true,
"isSubtropical": false,
"year": "2021"
},
{
"name": "LUPIT",
"basinId": "NP",
"govId": 13,
"isActive": true,
"isSubtropical": false,
"year": "2021"
},
{
"name": "FOURTEEN",
"basinId": "NP",
"govId": 14,
"isActive": true,
"isSubtropical": false,
"year": "2021"
},
{
"name": "FIFTEEN",
"basinId": "NP",
"govId": 15,
"isActive": true,
"isSubtropical": false,
"year": "2021"
}
]
}
Definities
| Name | Description |
|---|---|
|
Active |
Geeft essentiële details over lopende tropische stormen, zoals gerapporteerd door nationale weersvoorspellingsinstanties. |
|
Active |
Het ActiveStormResult-object biedt uitgebreide informatie over lopende tropische stormen. Het bevat een array van ActiveStorm-objecten , elk met specifieke kenmerken van individuele stormen. Deze kenmerken omvatten het overheids-ID, het bekken-ID, het ontstaansjaar, de naam en de subtropische status van de storm. |
|
Basin |
Bekkenidentificatie voor tropische stormen. |
|
Error |
Aanvullende informatie over de resourcebeheerfout. |
|
Error |
De foutdetails. |
|
Error |
Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.) |
|
Json |
Gewenste indeling van het antwoord. Alleen |
ActiveStorm
Geeft essentiële details over lopende tropische stormen, zoals gerapporteerd door nationale weersvoorspellingsinstanties.
| Name | Type | Description |
|---|---|---|
| basinId |
Categoriseert de verschillende oceaanbekkens waar tropische stormen kunnen ontstaan. Elk bekken krijgt een unieke identificatiecode toegewezen om de locatie van de oorsprong van de storm te helpen specificeren. Geldige bekkenidentificaties zijn onder andere AL, CP, EP, NI, NP, SI en SP. |
|
| govId |
integer (int32) |
Een unieke identificatie die door nationale weersvoorspellingsinstanties aan tropische stormen wordt toegekend. Deze identificatie helpt specifieke stormen nauwkeurig te volgen en te refereren, inclusief status, locatie en intensiteit. |
| isActive |
boolean |
Geeft aan of de tropische storm momenteel actief is. Als dat waar is, is de storm actief; als het niet klopt, is de storm niet actief. |
| isSubtropical |
boolean |
Een retourwaarde van true geeft aan dat de storm wordt geclassificeerd als een subtropische cycloon, wat betekent dat hij zowel tropische als extratropische kenmerken heeft. |
| name |
string |
De naam van de storm. |
| year |
string |
Geeft het jaar aan waarin de tropische storm is ontstaan. |
ActiveStormResult
Het ActiveStormResult-object biedt uitgebreide informatie over lopende tropische stormen. Het bevat een array van ActiveStorm-objecten , elk met specifieke kenmerken van individuele stormen. Deze kenmerken omvatten het overheids-ID, het bekken-ID, het ontstaansjaar, de naam en de subtropische status van de storm.
| Name | Type | Description |
|---|---|---|
| nextLink |
string |
Bevat de URL om de volgende pagina met resultaten op te halen als het antwoord gepagineerd is. Dit is handig wanneer het antwoord te groot is om in één oproep te worden beantwoord, waardoor gebruikers door meerdere pagina's met resultaten kunnen navigeren. |
| results |
Een reeks ActiveStorm-objecten , elk met essentiële details over een lopende tropische storm, zoals gerapporteerd door nationale weersvoorspellingsinstanties. |
BasinId
Bekkenidentificatie voor tropische stormen.
| Waarde | Description |
|---|---|
| AL |
De Atlantische Oceaan. Cruciaal voor het volgen van orkanen die Amerika en het Caribisch gebied treffen. Het is een van de meest actieve regio's voor tropische stormen. |
| CP |
De centrale Stille Oceaan. Dit bekken wordt gebruikt voor stormen die Hawaï en de omliggende gebieden treffen. |
| EP |
De oostelijke Stille Oceaan. Dit bekken volgt stormen die de westkust van Amerika treffen, inclusief Mexico en Midden-Amerika. Het grenst aan het centrale stroomgebied van de Stille Oceaan. |
| NI |
De Noord-Indische Oceaan. Dit bekken omvat stormen die Zuid-Azië treffen, waaronder landen als India en Bangladesh, die vaak worden getroffen door cyclonen. |
| NP |
Het noordwesten van de Stille Oceaan. Dit bekken is belangrijk voor het volgen van tyfoons die Oost-Azië treffen, waaronder landen als China, Japan en de Filippijnen. Het zijn de meest actieve tropische stormgebieden ter wereld. |
| SI |
De Zuid-Indische Oceaan. Dit bekken, gelegen ten zuiden van de evenaar, omvat cyclonen die Madagaskar, Afrika en de omliggende regio's treffen. |
| SP |
De Stille Zuidzee. Dit bekken, gelegen ten zuiden van de evenaar, is relevant voor cyclonen die Australië en de eilanden in de Stille Zuidzee treffen. |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
| Name | Type | Description |
|---|---|---|
| info |
De aanvullende informatie. |
|
| type |
string |
Het extra informatietype. |
ErrorDetail
De foutdetails.
| Name | Type | Description |
|---|---|---|
| additionalInfo |
De fout bevat aanvullende informatie. |
|
| code |
string |
De foutcode. |
| details |
De foutdetails. |
|
| message |
string |
Het foutbericht. |
| target |
string |
Het foutdoel. |
ErrorResponse
Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
| Name | Type | Description |
|---|---|---|
| error |
Het foutobject. |
JsonFormat
Gewenste indeling van het antwoord. Alleen json indeling wordt ondersteund.
| Waarde | Description |
|---|---|
| json |
De Notatie Data Interchange-indeling voor JavaScript-objecten |