Weather - Get Tropical Storm Forecast

Reference

Služba:: Maps

Verze rozhraní API:: 1.1

Použijte k získání seznamu tropických bouří předpovídajících národní agentury pro předpověď počasí.

Rozhraní Get Tropical Storm Forecasts API je požadavek HTTP GET , který vrací jednotlivé předpovědi tropických bouří vydaných vládou. Informace o předpokládaných tropických bouřích zahrnují umístění, stav, datum vytvoření prognózy, okno, rychlost větru a poloměry větru.

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

S volitelnými parametry:

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
format	path	True	JsonFormat	Požadovaný formát odpovědi. Podporuje se pouze `json` formát.
api-version	query	True	string	Číslo verze rozhraní API služby Azure Maps
basinId	query	True	basinId	Identifikátor pánve
govId	query	True	integer int32	ID bouře státní správy
year	query	True	integer int32	Rok cyklonu (cyklónů)
details	query		boolean	Pokud je hodnota true, jsou v odpovědi zahrnuta souhrnná data poloměrů větru.
radiiGeometry	query		boolean	V případě hodnoty true jsou v odpovědi zahrnuta souhrnná data o poloměrech větru a podrobnosti o geoJSON.
unit	query		WeatherDataUnit	Určuje, že se mají vracet data buď v jednotkách metrik, nebo v jednotkách impéria. Výchozí hodnota je metrika.
windowGeometry	query		boolean	Pokud je true, jsou do odpovědi zahrnuta data geometrie okna (geoJSON).

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-id		string	Určuje, který účet je určen pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a dá se načíst z rozhraní API účtu roviny správy Služby Azure Maps. Informace o použití zabezpečení Microsoft Entra ID ve službě Azure Maps najdete v následujících článcích .

Odpovědi

Name	Typ	Description
200 OK	StormForecastResult	OK
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

Zabezpečení

AADToken

Toto jsou toky Microsoft Entra OAuth 2.0 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k rozhraním REST API služby Azure Maps. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika účtům prostředků nebo dílčím prostředkům Azure Maps. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k rozhraním REST API služby Azure Maps.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení prostředku Azure Maps, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map .

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití webové sady SDK služby Azure Maps umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Další informace o platformě Microsoft Identity Platform najdete v tématu Přehled platformy Microsoft Identity Platform.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jedná se o sdílený klíč, který se zřídí při vytvoření účtu Azure Maps na webu Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace přístup ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve který je vystavený.

U veřejně vystavených aplikací doporučujeme použít pro přístup k rozhraním REST API služby Azure Maps přístup k důvěrným klientským aplikacím , aby se váš klíč mohl bezpečně uložit.

Typ: apiKey
V: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v prostředku Azure Maps prostřednictvím roviny správy Azure portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.

Typ: apiKey
V: header

Příklady

Get Tropical Storm Forecasts

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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
        }
      }
    }
  ]
}

Definice

Name	Description
basinId	Identifikátor umyvadla
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď
GeoJsonGeometry	Platný `GeoJSON` objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonGeometryCollection	Platný `GeoJSON GeometryCollection` typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonLineString	Platný `GeoJSON LineString` typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonMultiLineString	Platný `GeoJSON MultiLineString` typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonMultiPoint	Platný `GeoJSON MultiPoint` typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonMultiPolygon	Platný `GeoJSON MultiPolygon` typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonPoint	Platný `GeoJSON Point` typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonPolygon	Platný `GeoJSON Polygon` typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
JsonFormat	Požadovaný formát odpovědi Podporuje se pouze `json` formát.
LatLongPair	Umístění reprezentované jako zeměpisná šířka a délka.
RadiusSector	Ložisko 0–90 = NE kvadrant; 90–180 = SE kvadrant; 180–270 = SW kvadrant; 270–360 = NW kvadrant.
StormForecast	Předpověď bouřek vystavených vládou
StormForecastResult	Seznam prognóz vydaných vládou
StormWindRadiiSummary	Zobrazí se, když v požadavku details=true nebo radiiGeometry=true.
UnitType	Číselná hodnota ID přidružená k typu zobrazené jednotky. Lze použít k překladu jednotek. Podrobnosti najdete v tématu Služby Počasí v Azure Maps .
WeatherDataUnit	Určuje, že se mají vracet data v metrických nebo imperiálních jednotkách. Výchozí hodnota je metrika.
WeatherUnit	Konkrétní hodnota dané jednotky související s počasím.
WeatherWindow	Okno prognózy pro bouřku

basinId

Identifikátor umyvadla

Name	Typ	Description
AL	string	Atlantik
CP	string	Střední Tichomoří
EP	string	Východní Tichomoří
NI	string	Severní Indický oceán
NP	string	Severozápad Tichomoří
SI	string	Jihozápad Indického oceánu
SP	string	Jižní Tichomoří

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

GeoJsonGeometry

Platný GeoJSON objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
type	GeoJsonObjectType	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonGeometryCollection

Platný GeoJSON GeometryCollection typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Obsahuje seznam platných `GeoJSON` objektů geometrie. Všimněte si , že souřadnice v GeoJSON jsou v pořadí x, y (zeměpisná délka, zeměpisná šířka).
type	string: GeometryCollection	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonLineString

Platný GeoJSON LineString typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
coordinates	number[]	Souřadnice `GeoJson LineString` geometrie.
type	string: LineString	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonMultiLineString

Platný GeoJSON MultiLineString typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
coordinates	number[]	Souřadnice `GeoJson MultiLineString` geometrie.
type	string: MultiLineString	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonMultiPoint

Platný GeoJSON MultiPoint typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
coordinates	number[]	Souřadnice `GeoJson MultiPoint` geometrie.
type	string: MultiPoint	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonMultiPolygon

Platný GeoJSON MultiPolygon typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
coordinates	number[]	Obsahuje seznam platných `GeoJSON Polygon` objektů. Všimněte si , že souřadnice v GeoJSON jsou v pořadí x, y (zeměpisná délka, zeměpisná šířka).
type	string: MultiPolygon	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonPoint

Platný GeoJSON Point typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
coordinates	number[]	A `Position` je matice čísel se dvěma nebo více prvky. První dva prvky jsou zeměpisná délka a zeměpisná šířka, přesně v daném pořadí. Třetí volitelný prvek je nadmořská výška/nadmořská výška. Podrobnosti najdete v dokumentu RFC 7946 .
type	string: Point	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonPolygon

Platný GeoJSON Polygon typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
coordinates	number[]	Souřadnice typu `GeoJson Polygon` geometrie.
type	string: Polygon	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

JsonFormat

Požadovaný formát odpovědi Podporuje se pouze json formát.

Name	Typ	Description
json	string	Formát výměny dat zápisu objektů JavaScriptu

LatLongPair

Umístění reprezentované jako zeměpisná šířka a délka.

Name	Typ	Description
latitude	number	Vlastnost Zeměpisná šířka
longitude	number	Zeměpisná délka – vlastnost

RadiusSector

Ložisko 0–90 = NE kvadrant; 90–180 = SE kvadrant; 180–270 = SW kvadrant; 270–360 = NW kvadrant.

Name	Typ	Description
beginBearing	number	Ložisko ve stupních začátku kvadrantu.
endBearing	number	Ložisko ve stupních konce kvadrantu.
range	number	Poloměr kvadrantu v námořních mílích.

StormForecast

Předpověď bouřek vystavených vládou

Name	Typ	Description
dateTime	string	Datum a čas: prognóza je platná a zobrazuje se ve formátu ISO8601.
initializedDateTime	string	Datum a čas vytvoření prognózy zobrazené ve formátu ISO8601.
location	LatLongPair	Souřadnice bouře
maxWindGust	WeatherUnit	Maximální rychlost nárazů větru spojená s bouří. Může mít hodnotu NULL.
status	string	Mezi možné hodnoty stavu patří: Cyklonová bouře Hluboké deprese Deprese Extrémně silná cyklonová bouře Kategorie hurikánů (1-5) Intenzivní tropický cyklón Mírná tropická bouře Posttropické cyklóny Potenciální tropický cyklón Silná cyklonová bouře Silná tropická bouře Subtropický Supercylonová bouře Tropický cyklón Tropická cyklóna kategorie (1-5) Tropická deprese Tropické poruchy Tropická bouře Tajfun Velmi intenzivní tropický cyklón Velmi silná cyklonová bouře Velmi silný tajfun Násilná tajfun
sustainedWind	WeatherUnit	Maximální rychlost větru spojená s bouří. Může mít hodnotu NULL.
windRadiiSummary	StormWindRadiiSummary[]	Zobrazí se, když v požadavku details=true nebo radiiGeometry=true.
window	WeatherWindow	Obsahuje informace o okně prognózy bouře během zadaného časového období (ne o celém kuželu). Pokud windowGeometry=true v požadavku, tento objekt bude obsahovat podrobnosti geoJSON pro geometrii okna.

StormForecastResult

Seznam prognóz vydaných vládou

Name	Typ	Description
nextLink	string	Je odkaz na další stránku vrácených funkcí. Pokud se jedná o poslední stránku, toto pole není.
results	StormForecast[]	Seznam prognóz vydaných vládou

StormWindRadiiSummary

Zobrazí se, když v požadavku details=true nebo radiiGeometry=true.

Name	Typ	Description
dateTime	string	DateTime, pro které jsou platná souhrnná data o poloměrech větru, zobrazená ve formátu ISO8601.
radiiGeometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Objekt GeoJSON. Zobrazí se při radiiGeometry=true v požadavku. Popisuje obrys kvadrantů poloměru větru.
radiusSectorData	RadiusSector[]	Obsahuje informace potřebné k vykreslení kvadrantů poloměru větru. Ložisko 0–90 = NE kvadrant; 90–180 = SE kvadrant; 180–270 = SW kvadrant; 270–360 = NW kvadrant.
windSpeed	WeatherUnit	Rychlost větru přidružená k radiusSectorData.

UnitType

Číselná hodnota ID přidružená k typu zobrazené jednotky. Lze použít k překladu jednotek. Podrobnosti najdete v tématu Služby Počasí v 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

Určuje, že se mají vracet data v metrických nebo imperiálních jednotkách. Výchozí hodnota je metrika.

Name	Typ	Description
imperial	string	Vrátí data v imperiálních jednotkách. Mezi příklady jednotek císařského systému patří Fahrenheita a míle.
metric	string	Vrátí data v metrických jednotkách. Mezi ukázkové jednotky metrického systému patří stupně Celsia a kilometry.

WeatherUnit

Konkrétní hodnota dané jednotky související s počasím.

Name	Typ	Description
unit	string	Typ jednotky pro vrácenou hodnotu.
unitType	UnitType	Číselná hodnota ID přidružená k typu zobrazené jednotky. Lze použít k překladu jednotek. Podrobnosti najdete v tématu Služby Počasí v Azure Maps .
value	number	Zaokrouhlená hodnota.

WeatherWindow

Okno prognózy pro bouřku

Name	Typ	Description
beginDateTime	string	DateTime začátku okna pohybu, zobrazený ve formátu ISO8601.
beginStatus	string	Stav stormu na začátku okna.
endDateTime	string	Datum A čas konce okna pohybu zobrazený ve formátu ISO8601.
endStatus	string	Stav Storm na konci okna.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Zobrazí se, když windowGeometry=true v požadavku. Objekt GeoJSON obsahující souřadnice popisující okno pohybu během zadaného časového rámce.
left	LatLongPair	Umístění bodu na levé straně okna v době časového rámce.
right	LatLongPair	Umístění bodu na pravé straně okna na konci časového rámce

Sdílet prostřednictvím