Weather - Get Tropical Storm Locations
Använd för att hämta platsen för tropiska stormar från enskilda nationella väderprognosbyråer.
API:et Get Tropical Storm Locations
är en HTTP-begäran GET
som returnerar platsen för enskilda myndighetsutfärdade tropiska stormar. Information om tropiska stormar inkluderar platskoordinater, geometri, bassäng-ID, datum, vindinformation och vindradii.
GET https://atlas.microsoft.com/weather/tropical/storms/locations/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}
GET https://atlas.microsoft.com/weather/tropical/storms/locations/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}&details={details}&radiiGeometry={radiiGeometry}&unit={unit}¤t={current}
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
format
|
path | True |
Önskat format för svaret. Endast |
|
api-version
|
query | True |
string |
Versionsnummer för Azure Maps API. |
basin
|
query | True |
Bassängidentifierare |
|
gov
|
query | True |
integer int32 |
Regeringens storm-ID |
year
|
query | True |
integer int32 |
Cyklonens år |
current
|
query |
boolean |
När det är sant returnerar du den aktuella stormplatsen |
|
details
|
query |
boolean |
När det är sant inkluderas sammanfattningsdata för vindradii i svaret |
|
radii
|
query |
boolean |
När det är sant inkluderas sammanfattningsdata för vindradii och geoJSON-information i svaret |
|
unit
|
query |
Anger att data ska returneras i antingen måttenheter eller kejserliga enheter. Standardvärdet är mått. |
Begärandehuvud
Name | Obligatorisk | Typ | Description |
---|---|---|---|
x-ms-client-id |
string |
Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID-säkerhetsmodellen. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i följande artiklar . |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Det uppstod ett oväntat fel. |
Säkerhet
AADToken
Det här är Microsoft Entra OAuth 2.0-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till REST-API:er för Azure Maps. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Rest-API:er för Azure Maps.
För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan ha åtkomstkontroll för specifika API:er och omfång.
Kommentarer
- Den här säkerhetsdefinitionen
x-ms-client-id
kräver att huvudet används för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API :et.
Authorization URL
är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer.
* Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
* Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
- Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Det här är en delad nyckel som etableras när du skapar ett Azure Maps-konto i Azure-portalen eller använder PowerShell, CLI, Azure SDK:er eller REST API.
Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som huvudnyckel i det konto som de har utfärdats i.
För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att få åtkomst till REST-API:er för Azure Maps så att din nyckel kan lagras på ett säkert sätt.
Typ:
apiKey
I:
query
SAS Token
Det här är en signaturtoken för delad åtkomst som skapas från åtgärden List SAS på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett säkrare sätt än den delade nyckeln.
För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.
Typ:
apiKey
I:
header
Exempel
Get Tropical Storm Current Location |
Get Tropical Storm Locations |
Get Tropical Storm Current Location
Exempelbegäran
GET https://atlas.microsoft.com/weather/tropical/storms/locations/json?api-version=1.1&year=2021&basinId=NP&govId=2¤t=True
Exempelsvar
{
"results": [
{
"dateTime": "2021-04-24T18:00:00+00:00",
"location": {
"latitude": 21.7,
"longitude": 134.1
},
"maxWindGust": {
"value": 92.6,
"unit": "km/h",
"unitType": 7
},
"sustainedWind": {
"value": 74.1,
"unit": "km/h",
"unitType": 7
},
"movement": {
"direction": {
"degrees": 115,
"localizedDescription": "ESE"
},
"speed": {
"value": 22.2,
"unit": "km/h",
"unitType": 7
}
},
"status": "Tropical Storm"
}
]
}
Get Tropical Storm Locations
Exempelbegäran
GET https://atlas.microsoft.com/weather/tropical/storms/locations/json?api-version=1.1&year=2021&basinId=NP&govId=1
Exempelsvar
{
"results": [
{
"dateTime": "2021-02-22T00:00:00+00:00",
"location": {
"latitude": 10.4,
"longitude": 125.7
},
"maxWindGust": {
"value": 64.8,
"unit": "km/h",
"unitType": 7
},
"sustainedWind": {
"value": 46.3,
"unit": "km/h",
"unitType": 7
},
"movement": {
"direction": {
"degrees": 305,
"localizedDescription": "NW"
},
"speed": {
"value": 9.3,
"unit": "km/h",
"unitType": 7
}
},
"status": "Tropical Depression"
},
{
"dateTime": "2021-02-21T18:00:00+00:00",
"location": {
"latitude": 10.2,
"longitude": 125.9
},
"maxWindGust": {
"value": 64.8,
"unit": "km/h",
"unitType": 7
},
"sustainedWind": {
"value": 46.3,
"unit": "km/h",
"unitType": 7
},
"movement": {
"direction": {
"degrees": 300,
"localizedDescription": "WNW"
},
"speed": {
"value": 22.2,
"unit": "km/h",
"unitType": 7
}
},
"status": "Tropical Depression"
},
{
"dateTime": "2021-02-21T12:00:00+00:00",
"location": {
"latitude": 10.3,
"longitude": 125.8
},
"maxWindGust": {
"value": 83.3,
"unit": "km/h",
"unitType": 7
},
"sustainedWind": {
"value": 64.8,
"unit": "km/h",
"unitType": 7
},
"movement": {
"direction": {
"degrees": 300,
"localizedDescription": "WNW"
},
"speed": {
"value": 42.6,
"unit": "km/h",
"unitType": 7
}
},
"status": "Tropical Storm"
},
{
"dateTime": "2021-02-19T06:00:00+00:00",
"location": {
"latitude": 7.2,
"longitude": 129.8
},
"maxWindGust": {
"value": 101.9,
"unit": "km/h",
"unitType": 7
},
"sustainedWind": {
"value": 83.3,
"unit": "km/h",
"unitType": 7
},
"movement": {
"direction": {
"degrees": 270,
"localizedDescription": "W"
},
"speed": {
"value": 18.5,
"unit": "km/h",
"unitType": 7
}
},
"status": "Tropical Storm"
},
{
"dateTime": "2021-02-19T00:00:00+00:00",
"location": {
"latitude": 7.2,
"longitude": 131.2
},
"maxWindGust": {
"value": 101.9,
"unit": "km/h",
"unitType": 7
},
"sustainedWind": {
"value": 83.3,
"unit": "km/h",
"unitType": 7
},
"movement": {
"direction": {
"degrees": 270,
"localizedDescription": "W"
},
"speed": {
"value": 7.4,
"unit": "km/h",
"unitType": 7
}
},
"status": "Tropical Storm"
},
{
"dateTime": "2021-02-18T18:00:00+00:00",
"location": {
"latitude": 7.2,
"longitude": 131.7
},
"maxWindGust": {
"value": 83.3,
"unit": "km/h",
"unitType": 7
},
"sustainedWind": {
"value": 64.8,
"unit": "km/h",
"unitType": 7
},
"movement": {
"direction": {
"degrees": 270,
"localizedDescription": "W"
},
"speed": {
"value": 3.7,
"unit": "km/h",
"unitType": 7
}
},
"status": "Tropical Storm"
},
{
"dateTime": "2021-02-18T12:00:00+00:00",
"location": {
"latitude": 7.3,
"longitude": 131.8
},
"maxWindGust": {
"value": 83.3,
"unit": "km/h",
"unitType": 7
},
"sustainedWind": {
"value": 64.8,
"unit": "km/h",
"unitType": 7
},
"movement": {
"direction": {
"degrees": 270,
"localizedDescription": "W"
},
"speed": {
"value": 5.6,
"unit": "km/h",
"unitType": 7
}
},
"status": "Tropical Storm"
},
{
"dateTime": "2021-02-18T06:00:00+00:00",
"location": {
"latitude": 7.3,
"longitude": 132.1
},
"maxWindGust": {
"value": 83.3,
"unit": "km/h",
"unitType": 7
},
"sustainedWind": {
"value": 64.8,
"unit": "km/h",
"unitType": 7
},
"movement": {
"direction": {
"degrees": 305,
"localizedDescription": "NW"
},
"speed": {
"value": 9.3,
"unit": "km/h",
"unitType": 7
}
},
"status": "Tropical Storm"
},
{
"dateTime": "2021-02-18T00:00:00+00:00",
"location": {
"latitude": 7,
"longitude": 132.6
},
"maxWindGust": {
"value": 83.3,
"unit": "km/h",
"unitType": 7
},
"sustainedWind": {
"value": 64.8,
"unit": "km/h",
"unitType": 7
},
"movement": {
"direction": {
"degrees": 290,
"localizedDescription": "WNW"
},
"speed": {
"value": 5.6,
"unit": "km/h",
"unitType": 7
}
},
"status": "Tropical Storm"
},
{
"dateTime": "2021-02-17T18:00:00+00:00",
"location": {
"latitude": 7,
"longitude": 132.7
},
"maxWindGust": {
"value": 74.1,
"unit": "km/h",
"unitType": 7
},
"sustainedWind": {
"value": 55.6,
"unit": "km/h",
"unitType": 7
},
"movement": {
"direction": {
"degrees": 290,
"localizedDescription": "WNW"
},
"speed": {
"value": 9.3,
"unit": "km/h",
"unitType": 7
}
},
"status": "Tropical Depression"
},
{
"dateTime": "2021-02-17T12:00:00+00:00",
"location": {
"latitude": 6.8,
"longitude": 132.4
},
"maxWindGust": {
"value": 74.1,
"unit": "km/h",
"unitType": 7
},
"sustainedWind": {
"value": 55.6,
"unit": "km/h",
"unitType": 7
},
"movement": {
"direction": {
"degrees": 285,
"localizedDescription": "WNW"
},
"speed": {
"value": 13,
"unit": "km/h",
"unitType": 7
}
},
"status": "Tropical Depression"
},
{
"dateTime": "2021-02-17T06:00:00+00:00",
"location": {
"latitude": 6.6,
"longitude": 133.1
},
"maxWindGust": {
"value": 64.8,
"unit": "km/h",
"unitType": 7
},
"sustainedWind": {
"value": 46.3,
"unit": "km/h",
"unitType": 7
},
"movement": {
"direction": {
"degrees": 270,
"localizedDescription": "W"
},
"speed": {
"value": 22.2,
"unit": "km/h",
"unitType": 7
}
},
"status": "Tropical Depression"
}
]
}
Definitioner
Name | Description |
---|---|
basin |
Bassängidentifierare |
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Geo |
Ett giltigt |
Geo |
En giltig |
Geo |
En giltig |
Geo |
En giltig |
Geo |
En giltig |
Geo |
En giltig |
Geo |
En giltig |
Geo |
En giltig |
Json |
Önskat format för svaret. Endast |
Lat |
En plats som representeras som latitud och longitud. |
Radius |
Bärande 0–90 = NE-kvadrant; 90–180 = SE-kvadrant; 180–270 = KVADRANT; 270–360 = NW kvadrant. |
Storm |
Plats för en enskild storm från regeringen |
Storm |
Platser för en enskild storm som utfärdats av regeringen |
Storm |
Visas när details=true eller radiiGeometry=true i begäran. |
Unit |
Numeriskt ID-värde som är associerat med den typ av enhet som visas. Kan användas för enhetsöversättning. Mer information finns i Vädertjänster i Azure Maps . |
Weather |
Anger att data ska returneras i antingen måttenheter eller kejserliga enheter. Standardvärdet är mått. |
Weather |
Specifikt värde för en viss enhet som är relaterad till väder. |
Wind |
Vinddetaljer returneras inklusive hastighet och riktning. |
Wind |
Vindriktning |
basinId
Bassängidentifierare
Name | Typ | Description |
---|---|---|
AL |
string |
Atlanten |
CP |
string |
Centrala Stillahavsområdet |
EP |
string |
Östra Stillahavsområdet |
NI |
string |
Norra Indiska oceanen |
NP |
string |
Nordvästra Stillahavsområdet |
SI |
string |
Sydvästra Indiska oceanen |
SP |
string |
Södra Stillahavsområdet |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Den ytterligare informationen. |
type |
string |
Ytterligare informationstyp. |
ErrorDetail
Felinformationen.
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
GeoJsonGeometry
Ett giltigt GeoJSON
geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
type |
Geo |
Anger |
GeoJsonGeometryCollection
En giltig GeoJSON GeometryCollection
objekttyp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
geometries | GeoJsonGeometry[]: |
Innehåller en lista över giltiga |
type |
string:
Geometry |
Anger |
GeoJsonLineString
En giltig GeoJSON LineString
geometrityp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
Koordinater för geometrin |
type |
string:
Line |
Anger |
GeoJsonMultiLineString
En giltig GeoJSON MultiLineString
geometrityp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
Koordinater för geometrin |
type |
string:
Multi |
Anger |
GeoJsonMultiPoint
En giltig GeoJSON MultiPoint
geometrityp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
Koordinater för |
type |
string:
Multi |
Anger |
GeoJsonMultiPolygon
En giltig GeoJSON MultiPolygon
objekttyp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
Innehåller en lista över giltiga |
type |
string:
Multi |
Anger |
GeoJsonPoint
En giltig GeoJSON Point
geometrityp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
A |
type |
string:
Point |
Anger |
GeoJsonPolygon
En giltig GeoJSON Polygon
geometrityp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
Koordinater för |
type |
string:
Polygon |
Anger |
JsonFormat
Önskat format för svaret. Endast json
format stöds.
Name | Typ | Description |
---|---|---|
json |
string |
LatLongPair
En plats som representeras som latitud och longitud.
Name | Typ | Description |
---|---|---|
latitude |
number |
Latitude-egenskap |
longitude |
number |
Longitudegenskap |
RadiusSector
Bärande 0–90 = NE-kvadrant; 90–180 = SE-kvadrant; 180–270 = KVADRANT; 270–360 = NW kvadrant.
Name | Typ | Description |
---|---|---|
beginBearing |
number |
Lager, i grader, i början av kvadranten. |
endBearing |
number |
Lager, i grader, i slutet av kvadranten. |
range |
number |
Kvadrantens radie, i nautiska mil. |
StormLocation
Plats för en enskild storm från regeringen
Name | Typ | Description |
---|---|---|
dateTime |
string |
Datetime prognosen är giltig, visas i ISO8601 format. |
hasTropicalPotential |
boolean |
Sant när stormen kan utvecklas till ett tropiskt system. |
isPostTropical |
boolean |
Sant när stormen försvagas bort, och kommer inte längre att bli ett tropiskt system. |
isSubtropical |
boolean |
Sant när depressionen klassificeras som en subtropisk cyklon. |
location |
Stormens koordinater |
|
maxWindGust |
Maximal vindbyshastighet i samband med stormen. Kan vara NULL. |
|
minimumPressure |
Minimitryck i samband med stormen. Kan vara NULL. |
|
movement |
Stormrörelsens information. |
|
status |
string |
Stormstatus på engelska. |
sustainedWind |
Maximal ihållande vindhastighet i samband med stormen. Kan vara NULL. |
|
windRadiiSummary |
Visas när details=true eller radiiGeometry=true i begäran. |
StormLocationsResult
Platser för en enskild storm som utfärdats av regeringen
Name | Typ | Description |
---|---|---|
nextLink |
string |
är länken till nästa sida i de funktioner som returneras. Om det är den sista sidan, nej det här fältet. |
results |
Platser för en enskild storm som utfärdats av regeringen |
StormWindRadiiSummary
Visas när details=true eller radiiGeometry=true i begäran.
Name | Typ | Description |
---|---|---|
dateTime |
string |
DateTime som wind radii-sammanfattningsdata är giltiga för, visas i ISO8601 format. |
radiiGeometry | GeoJsonGeometry: |
GeoJSON-objekt. Visas när radiiGeometry=true i begäran. Beskriver konturen av vindradiekvadranterna. |
radiusSectorData |
Innehåller den information som behövs för att rita vindradiekvadranter. Bärande 0–90 = NE-kvadrant; 90–180 = SE-kvadrant; 180–270 = KVADRANT; 270–360 = NW kvadrant. |
|
windSpeed |
Vindhastighet som är associerad med radiusSectorData. |
UnitType
Numeriskt ID-värde som är associerat med den typ av enhet som visas. Kan användas för enhetsöversättning. Mer information finns i Vädertjänster i Azure Maps .
Name | Typ | Description |
---|---|---|
0 |
Integer |
|
1 |
Integer |
|
10 |
Integer |
|
11 |
Integer |
|
12 |
Integer |
|
13 |
Integer |
|
14 |
Integer |
|
15 |
Integer |
|
16 |
Integer |
|
17 |
Integer |
|
18 |
Integer |
|
19 |
Integer |
|
2 |
Integer |
|
20 |
Integer |
|
21 |
Integer |
|
22 |
Integer |
|
3 |
Integer |
|
31 |
Integer |
|
4 |
Integer |
|
5 |
Integer |
|
6 |
Integer |
|
7 |
Integer |
|
8 |
Integer |
|
9 |
Integer |
WeatherDataUnit
Anger att data ska returneras i antingen måttenheter eller kejserliga enheter. Standardvärdet är mått.
Name | Typ | Description |
---|---|---|
imperial |
string |
Returnera data i kejserliga enheter. Några exempelenheter i det kejserliga systemet är Fahrenheit och mile. |
metric |
string |
Returnera data i måttenheter. Några exempelenheter för måttsystem är Celsius och kilometer. |
WeatherUnit
Specifikt värde för en viss enhet som är relaterad till väder.
Name | Typ | Description |
---|---|---|
unit |
string |
Typ av enhet för det returnerade värdet. |
unitType |
Numeriskt ID-värde som är associerat med den typ av enhet som visas. Kan användas för enhetsöversättning. Mer information finns i Vädertjänster i Azure Maps . |
|
value |
number |
Avrundat värde. |
WindDetails
Vinddetaljer returneras inklusive hastighet och riktning.
Name | Typ | Description |
---|---|---|
direction |
Vindriktning |
|
speed |
Vindhastighet i angiven enhet. |
WindDirection
Vindriktning
Name | Typ | Description |
---|---|---|
degrees |
integer |
Vindriktning i Azimuth grader, börjar på true North och fortsätter i medurs riktning. Nord är 0 grader, öst är 90 grader, söder är 180 grader, väst är 270 grader. Möjliga värden 0–359. |
localizedDescription |
string |
Riktningsförkortning på det angivna språket. |