Weather - Get Tropical Storm Forecast

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.1

Użyj, aby uzyskać listę burz tropikalnych prognozowanych przez krajowe agencje prognozowania pogody.

Interfejs Get Tropical Storm Forecasts API to żądanie HTTP GET zwracające indywidualne prognozy burzy tropikalnej wydane przez rząd. Informacje o prognozowanych burzach tropikalnych obejmują, lokalizację, stan, datę utworzenia prognozy, okno, prędkość wiatru i promienie wiatru.

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

Z parametrami opcjonalnymi:

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 identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko `json` format.
api-version	query	True	string	Numer wersji interfejsu API usługi Azure Maps.
basinId	query	True	basinId	Identyfikator basenu
govId	query	True	integer int32	Identyfikator burzy dla instytucji rządowych
year	query	True	integer int32	Rok cyklonów
details	query		boolean	W przypadku wartości true dane podsumowania promieni wiatru są uwzględniane w odpowiedzi
radiiGeometry	query		boolean	W przypadku wartości true dane podsumowania promieni wiatru i szczegóły geoJSON są uwzględniane w odpowiedzi
unit	query		WeatherDataUnit	Określa, aby zwracać dane w jednostkach metryk lub jednostkach imperialnych. Wartość domyślna to metryka.
windowGeometry	query		boolean	W przypadku wartości true dane geometrii okna (geoJSON) są uwzględniane w odpowiedzi

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Microsoft Entra ID. Reprezentuje unikatowy identyfikator konta usługi Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania usługi Azure Maps. Aby użyć zabezpieczeń microsoft Entra ID w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	StormForecastResult	OK
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy protokołu Microsoft Entra OAuth 2.0 . W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu oparte na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwagi

Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id , aby wskazać, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami .

Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów entra firmy Microsoft. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST. * Użycie zestawu Sdk sieci Web usługi Azure Maps umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Omówienie platformy tożsamości firmy Microsoft.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenia konta usługi Azure Maps w witrynie Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu do interfejsów API REST usługi Azure Maps, aby można było bezpiecznie przechowywać klucz.

Typ: apiKey
W: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.

Typ: apiKey
W: header

Przykłady

Get Tropical Storm Forecasts

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
basinId	Identyfikator basenu
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
GeoJsonGeometry	Prawidłowy `GeoJSON` obiekt geometryczny. Typ musi być jednym z siedmiu prawidłowych typów geometrii GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon i GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
GeoJsonGeometryCollection	Prawidłowy `GeoJSON GeometryCollection` typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
GeoJsonLineString	Prawidłowy `GeoJSON LineString` typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
GeoJsonMultiLineString	Prawidłowy `GeoJSON MultiLineString` typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
GeoJsonMultiPoint	Prawidłowy `GeoJSON MultiPoint` typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
GeoJsonMultiPolygon	Prawidłowy `GeoJSON MultiPolygon` typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
GeoJsonPoint	Prawidłowy `GeoJSON Point` typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
GeoJsonPolygon	Prawidłowy `GeoJSON Polygon` typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko `json` format.
LatLongPair	Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna.
RadiusSector	Łożysko 0–90 = ćwiartka NE; 90–180 = ćwiartka SE; 180–270 = ćwiartka SW; 270–360 = ćwiartka NW.
StormForecast	Prognoza burza wydana przez rząd
StormForecastResult	Lista prognoz wydanych przez rząd
StormWindRadiiSummary	Wyświetlane, gdy details=true lub radiiGeometry=true w żądaniu.
UnitType	Wartość identyfikatora liczbowego skojarzona z wyświetlanym typem jednostki. Może być używany do tłumaczenia jednostkowego. Szczegółowe informacje można znaleźć w artykule Weather services in Azure Maps (Usługi pogodowe w usłudze Azure Maps ).
WeatherDataUnit	Określa, aby zwracać dane w jednostkach metryk lub jednostkach imperialnych. Wartość domyślna to metryka.
WeatherUnit	Określona wartość danej jednostki powiązanej z pogodą.
WeatherWindow	Okno prognozy dla burzy

basinId

Identyfikator basenu

Nazwa	Typ	Opis
AL	string	Atlantycki
CP	string	Środkowy Pacyfik
EP	string	Wschodni Pacyfik
NI	string	Ocean Północnoindyjski
NP	string	Północno-zachodni Pacyfik
SI	string	Południowo-zachodni Ocean Indyjski
SP	string	Południowy Pacyfik

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

GeoJsonGeometry

Prawidłowy GeoJSON obiekt geometryczny. Typ musi być jednym z siedmiu prawidłowych typów geometrii GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon i GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
type	GeoJsonObjectType	Określa `GeoJSON` typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonGeometryCollection

Prawidłowy GeoJSON GeometryCollection typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Zawiera listę prawidłowych `GeoJSON` obiektów geometrycznych. Należy pamiętać , że współrzędne w formacie GeoJSON są w kolejności x, y (długość geograficzna, szerokość geograficzna).
type	string: GeometryCollection	Określa `GeoJSON` typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonLineString

Prawidłowy GeoJSON LineString typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
coordinates	number[]	Współrzędne geometrii `GeoJson LineString` .
type	string: LineString	Określa `GeoJSON` typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonMultiLineString

Prawidłowy GeoJSON MultiLineString typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
coordinates	number[]	Współrzędne geometrii `GeoJson MultiLineString` .
type	string: MultiLineString	Określa `GeoJSON` typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonMultiPoint

Prawidłowy GeoJSON MultiPoint typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
coordinates	number[]	Współrzędne geometrii `GeoJson MultiPoint` .
type	string: MultiPoint	Określa `GeoJSON` typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonMultiPolygon

Prawidłowy GeoJSON MultiPolygon typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
coordinates	number[]	Zawiera listę prawidłowych `GeoJSON Polygon` obiektów. Należy pamiętać , że współrzędne w formacie GeoJSON są w kolejności x, y (długość geograficzna, szerokość geograficzna).
type	string: MultiPolygon	Określa `GeoJSON` typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonPoint

Prawidłowy GeoJSON Point typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
coordinates	number[]	A `Position` to tablica liczb z co najmniej dwoma elementami. Pierwsze dwa elementy to długość geograficzna i szerokość geograficzna, dokładnie w tej kolejności. Wysokość/wysokość jest opcjonalnym trzecim elementem. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
type	string: Point	Określa `GeoJSON` typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonPolygon

Prawidłowy GeoJSON Polygon typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
coordinates	number[]	Współrzędne dla `GeoJson Polygon` typu geometrii.
type	string: Polygon	Określa `GeoJSON` typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

JsonFormat

Żądany format odpowiedzi. Obsługiwany jest tylko json format.

Nazwa	Typ	Opis
json	string	Format wymiany danych notacji obiektów JavaScript

LatLongPair

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna.

Nazwa	Typ	Opis
latitude	number	Właściwość Szerokość geograficzna
longitude	number	Właściwość Długość geograficzna

RadiusSector

Łożysko 0–90 = ćwiartka NE; 90–180 = ćwiartka SE; 180–270 = ćwiartka SW; 270–360 = ćwiartka NW.

Nazwa	Typ	Opis
beginBearing	number	Łożysko, w stopniach, na początku ćwiartki.
endBearing	number	Łożysko w stopniach końca ćwiartki.
range	number	Promień ćwiartki, w milach morskich.

StormForecast

Prognoza burza wydana przez rząd

Nazwa	Typ	Opis
dateTime	string	Data/godzina prawidłowej prognozy wyświetlanej w formacie ISO8601.
initializedDateTime	string	Data/godzina utworzenia prognozy, wyświetlana w formacie ISO8601.
location	LatLongPair	Współrzędne burzy
maxWindGust	WeatherUnit	Maksymalna prędkość podmuchu wiatru związana z burzą. Może mieć wartość NULL.
status	string	Możliwe wartości stanu obejmują: Burza cyklnicza Głęboka depresja Depresja Niezwykle poważna burza cyklonowa Kategoria huraganu (1-5) Intensywny cyklon tropikalny Umiarkowana burza tropikalna Cyklon po tropikalnym Potencjalny cyklon tropikalny Poważna burza cyklonowa Poważna burza tropikalna Subtropikalny Super cyklonowa burza Cyklon tropikalny Kategoria cyklonu tropikalnego (1–5) Depresja tropikalna Zakłócenia tropikalne Burza tropikalna Tajfun Bardzo intensywny cyklon tropikalny Bardzo ciężka burza cyklonowa Bardzo silny tajfun Brutalny tajfun
sustainedWind	WeatherUnit	Maksymalna utrzymująca się prędkość wiatru związana z burzą. Może mieć wartość NULL.
windRadiiSummary	StormWindRadiiSummary[]	Wyświetlane, gdy details=true lub radiiGeometry=true w żądaniu.
window	WeatherWindow	Zawiera informacje o oknie prognozy dla burzy w określonym przedziale czasu (a nie całej stożku). Jeśli windowGeometry=true w żądaniu, ten obiekt będzie zawierać szczegóły geoJSON geometrii okna.

StormForecastResult

Lista prognoz wydanych przez rząd

Nazwa	Typ	Opis
nextLink	string	Jest to link do następnej strony zwróconych funkcji. Jeśli jest to ostatnia strona, nie ma tego pola.
results	StormForecast[]	Lista prognoz wydanych przez rząd

StormWindRadiiSummary

Wyświetlane, gdy details=true lub radiiGeometry=true w żądaniu.

Nazwa	Typ	Opis
dateTime	string	Data/godzina, dla której dane podsumowania promienia wiatru są prawidłowe, wyświetlane w formacie ISO8601.
radiiGeometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Obiekt GeoJSON. Wyświetlane, gdy radiiGeometry=true w żądaniu. Opisuje kontur ćwiartek promienia wiatru.
radiusSectorData	RadiusSector[]	Zawiera informacje potrzebne do wykreślenia ćwiartek promienia wiatru. Łożysko 0–90 = ćwiartka NE; 90–180 = ćwiartka SE; 180–270 = ćwiartka SW; 270–360 = ćwiartka NW.
windSpeed	WeatherUnit	Prędkość wiatru skojarzona z radiusSectorData.

UnitType

Wartość identyfikatora liczbowego skojarzona z wyświetlanym typem jednostki. Może być używany do tłumaczenia jednostkowego. Szczegółowe informacje można znaleźć w artykule Weather services in Azure Maps (Usługi pogodowe w usłudze Azure Maps ).

Nazwa	Typ	Opis
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

Określa, aby zwracać dane w jednostkach metryk lub jednostkach imperialnych. Wartość domyślna to metryka.

Nazwa	Typ	Opis
imperial	string	Zwraca dane w jednostkach imperialnych. Niektóre przykładowe jednostki systemu imperialnego to Fahrenheit i mile.
metric	string	Zwracanie danych w jednostkach metryk. Niektóre przykładowe jednostki systemu metryki to Stopnie Celsjusza i kilometr.

WeatherUnit

Określona wartość danej jednostki powiązanej z pogodą.

Nazwa	Typ	Opis
unit	string	Typ jednostki dla zwróconej wartości.
unitType	UnitType	Wartość identyfikatora liczbowego skojarzona z wyświetlanym typem jednostki. Może być używany do tłumaczenia jednostkowego. Szczegółowe informacje można znaleźć w artykule Weather services in Azure Maps (Usługi pogodowe w usłudze Azure Maps ).
value	number	Zaokrąglona wartość.

WeatherWindow

Okno prognozy dla burzy

Nazwa	Typ	Opis
beginDateTime	string	Data/godzina początku okna przenoszenia wyświetlana w formacie ISO8601.
beginStatus	string	Stan storm na początku okna.
endDateTime	string	Data/godzina zakończenia okna przenoszenia wyświetlana w formacie ISO8601.
endStatus	string	Stan storm na końcu okna.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Wyświetlane, gdy windowGeometry=true w żądaniu. Obiekt GeoJSON zawierający współrzędne opisujące okno przenoszenia w określonym przedziale czasu.
left	LatLongPair	Lokalizacja punktu po lewej stronie okna w czasie przedziału czasu.
right	LatLongPair	Lokalizacja punktu po prawej stronie okna na końcu przedziału czasu.

Udostępnij za pośrednictwem