Weather - Get Tropical Storm Forecast

Referens

Service:: Maps

API Version:: 1.1

Använd för att få en lista över tropiska stormar som prognostiserats av nationella väderprognosbyråer.

API:et Get Tropical Storm Forecasts är en HTTP-begäran GET som returnerar enskilda myndighetsutfärdade tropiska stormprognoser. Information om de prognostiserade tropiska stormarna inkluderar, plats, status, datum då prognosen skapades, fönster, vindhastighet och vindradier.

GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}

With optional parameters:

GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}&unit={unit}&details={details}&radiiGeometry={radiiGeometry}&windowGeometry={windowGeometry}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
format	path	True	JsonFormat	Önskat format för svaret. Endast `json` format stöds.
api-version	query	True	string	Versionsnummer för Azure Maps API.
basinId	query	True	basinId	Bassängidentifierare
govId	query	True	integer int32	Regeringens storm-ID
year	query	True	integer int32	Cyklonens år
details	query		boolean	När det är sant inkluderas sammanfattningsdata för wind radii i svaret
radiiGeometry	query		boolean	När det är sant inkluderas wind radii-sammanfattningsdata och geoJSON-information i svaret
unit	query		WeatherDataUnit	Anger att data ska returneras i antingen måttenheter eller kejserliga enheter. Standardvärdet är mått.
windowGeometry	query		boolean	När det är sant inkluderas fönstergeometridata (geoJSON) i svaret

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äkerhetsmodell. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps hanteringsplans konto-API. 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	StormForecastResult	OK
Other Status Codes	ErrorResponse	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 Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till en eller flera Azure Maps resurskonto 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 för att Azure Maps REST-API:er.

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 få åtkomstkontroll för specifika API:er och omfång.

Kommentarer

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från Maps Management-API :et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Den rollbaserade Azure-åtkomstkontrollen konfigureras från Azure-hanteringsplanet via Azure Portal, 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 Microsofts identitetsplattform översikt.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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 Skapa ett Azure Maps-konto i Azure Portal eller med hjälp av 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 en huvudnyckel i det konto som de utfärdas i.

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Type: apiKey
In: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, 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 mer säkert 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 återgivningsmissbruk och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

Get Tropical Storm Forecasts

Sample Request

HTTP

GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year=2021&basinId=NP&govId=2

Sample Response

Status code:: 200

{
  "results": [
    {
      "dateTime": "2021-04-25T06:00:00+00:00",
      "initializedDateTime": "2021-04-24T18:00:00+00:00",
      "location": {
        "latitude": 22,
        "longitude": 137.8
      },
      "maxWindGust": {
        "value": 92.6,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 74.1,
        "unit": "km/h",
        "unitType": 7
      },
      "status": "Tropical Storm",
      "window": {
        "left": {
          "latitude": 22.56387,
          "longitude": 137.739517
        },
        "right": {
          "latitude": 21.4361,
          "longitude": 137.860489
        }
      }
    },
    {
      "dateTime": "2021-04-25T18:00:00+00:00",
      "initializedDateTime": "2021-04-24T18:00:00+00:00",
      "location": {
        "latitude": 23.7,
        "longitude": 142.4
      },
      "maxWindGust": {
        "value": 92.6,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 74.1,
        "unit": "km/h",
        "unitType": 7
      },
      "status": "Tropical Storm",
      "window": {
        "left": {
          "latitude": 24.45283,
          "longitude": 142.055313
        },
        "right": {
          "latitude": 22.94641,
          "longitude": 142.744675
        }
      }
    }
  ]
}

Definitioner

Name	Description
basinId	Bassängidentifierare
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
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 .
GeoJsonGeometryCollection	En giltig `GeoJSON GeometryCollection` objekttyp. Mer information finns i RFC 7946 .
GeoJsonLineString	En giltig `GeoJSON LineString` geometrityp. Mer information finns i RFC 7946 .
GeoJsonMultiLineString	En giltig `GeoJSON MultiLineString` geometrityp. Mer information finns i RFC 7946 .
GeoJsonMultiPoint	En giltig `GeoJSON MultiPoint` geometrityp. Mer information finns i RFC 7946 .
GeoJsonMultiPolygon	En giltig `GeoJSON MultiPolygon` objekttyp. Mer information finns i RFC 7946 .
GeoJsonPoint	En giltig `GeoJSON Point` geometrityp. Mer information finns i RFC 7946 .
GeoJsonPolygon	En giltig `GeoJSON Polygon` geometrityp. Mer information finns i RFC 7946 .
JsonFormat	Önskat format för svaret. Endast `json` format stöds.
LatLongPair	En plats som representeras som latitud och longitud.
RadiusSector	Bärande 0–90 = NE-kvadrant; 90–180 = SE-kvadrant; 180–270 = KVADRANT; 270–360 = NW kvadrant.
StormForecast	Regeringens stormprognos
StormForecastResult	Listan över myndighetsutgivna prognoser
StormWindRadiiSummary	Visas när details=true eller radiiGeometry=true i begäran.
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.
WeatherDataUnit	Anger att data ska returneras i antingen måttenheter eller kejserliga enheter. Standardvärdet är mått.
WeatherUnit	Specifikt värde för en viss enhet som är relaterad till väder.
WeatherWindow	Prognosfönster för stormen

basinId

Bassängidentifierare

Name	Typ	Description
AL	string	Atlanten
CP	string	Centrala Stilla havet
EP	string	Östra Stilla havet
NI	string	Norra Indiska oceanen
NP	string	Nordvästra Stilla havet
SI	string	Sydvästra Indiska oceanen
SP	string	Södra Stillahavsområdet

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	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	GeoJsonObjectType	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonGeometryCollection

En giltig GeoJSON GeometryCollection objekttyp. Mer information finns i RFC 7946 .

Name	Typ	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Innehåller en lista över giltiga `GeoJSON` geometriobjekt. Observera att koordinaterna i GeoJSON är i x, y-ordning (longitud, latitud).
type	string: GeometryCollection	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonLineString

En giltig GeoJSON LineString geometrityp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	Koordinater för `GeoJson LineString` geometrin.
type	string: LineString	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonMultiLineString

En giltig GeoJSON MultiLineString geometrityp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	Koordinater för `GeoJson MultiLineString` geometrin.
type	string: MultiLineString	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonMultiPoint

En giltig GeoJSON MultiPoint geometrityp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	Koordinater för `GeoJson MultiPoint` geometrin.
type	string: MultiPoint	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonMultiPolygon

En giltig GeoJSON MultiPolygon objekttyp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	Innehåller en lista över giltiga `GeoJSON Polygon` objekt. Observera att koordinaterna i GeoJSON är i x, y-ordning (longitud, latitud).
type	string: MultiPolygon	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonPoint

En giltig GeoJSON Point geometrityp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	A `Position` är en matris med tal med två eller flera element. De två första elementen är longitud och latitud, exakt i den ordningen. Höjd/höjd är ett valfritt tredje element. Mer information finns i RFC 7946 .
type	string: Point	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonPolygon

En giltig GeoJSON Polygon geometrityp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	Koordinater för `GeoJson Polygon` geometritypen.
type	string: Polygon	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

JsonFormat

Önskat format för svaret. Endast json format stöds.

Name	Typ	Description
json	string	Datautbytesformat för JavaScript-objektnotation

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.

StormForecast

Regeringens stormprognos

Name	Typ	Description
dateTime	string	Datetime prognosen är giltig, visas i ISO8601 format.
initializedDateTime	string	Datetime som prognosen skapades, visas i ISO8601 format.
location	LatLongPair	Stormens koordinater
maxWindGust	WeatherUnit	Maximal vindbyhastighet i samband med stormen. Kan vara NULL.
status	string	Möjliga statusvärden är: Cyclonic storm Djup depression Depression Extremt allvarlig cyclonic storm Orkankategori (1-5) Intensiv tropisk cyklon Måttlig tropisk storm Posttropisk cyklon Potentiell tropisk cyklon Svår cyclonic storm Svår tropisk storm Subtropiska Super cyclonic storm Tropisk cyklon Kategori för tropisk cyklon (1-5) Tropisk depression Tropiska störningar Tropisk storm Tyfon Mycket intensiv tropisk cyklon Mycket allvarlig cyclonic storm Mycket stark tyfon Våldsam tyfon
sustainedWind	WeatherUnit	Maximal ihållande vindhastighet i samband med stormen. Kan vara NULL.
windRadiiSummary	StormWindRadiiSummary[]	Visas när details=true eller radiiGeometry=true i begäran.
window	WeatherWindow	Innehåller information om prognosfönstret för stormen under den angivna tidsperioden (inte hela konen). Om windowGeometry=true i begäran innehåller det här objektet geoJSON-information för fönstergeometri.

StormForecastResult

Listan över myndighetsutgivna prognoser

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	StormForecast[]	Listan över myndighetsutgivna prognoser

StormWindRadiiSummary

Visas när details=true eller radiiGeometry=true i begäran.

Name	Typ	Description
dateTime	string	DateTime som sammanfattningsdata för wind radii är giltiga för, visas i ISO8601 format.
radiiGeometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	GeoJSON-objekt. Visas när radiiGeometry=true i begäran. Beskriver konturerna för vindradiekvadranterna.
radiusSectorData	RadiusSector[]	Innehåller den information som behövs för att rita vindradiekvadranter. Bärande 0–90 = NE-kvadrant; 90–180 = SE-kvadrant; 180–270 = SW-kvadrant; 270–360 = NW-kvadrant.
windSpeed	WeatherUnit	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 av imperialistiskt system ä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	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.

WeatherWindow

Prognosfönster för stormen

Name	Typ	Description
beginDateTime	string	DateTime i början av rörelsefönstret, som visas i ISO8601 format.
beginStatus	string	Stormstatus i början av fönstret.
endDateTime	string	DateTime i slutet av rörelsefönstret, som visas i ISO8601 format.
endStatus	string	Stormstatus i slutet av fönstret.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Visas när windowGeometry=true i begäran. GeoJSON-objekt som innehåller koordinater som beskriver rörelsefönstret under den angivna tidsramen.
left	LatLongPair	Platsen för punkten till vänster i fönstret vid tidpunkten för tidsramen.
right	LatLongPair	Platsen för punkten till höger i fönstret i slutet av tidsramen.