Weather - Get Tropical Storm Active

Umożliwia to pobranie listy aktywnych burz tropikalnych wydanej przez krajowe agencje prognozowania pogody.
Interfejs Get Tropical Storm Active API to żądanie HTTP GET , które zwraca listę wszystkich aktywnych burz tropikalnych wydanych przez rząd. Informacje o burzach tropikalnych obejmują dowód osobisty, identyfikator dorzecza, rok powstania, nazwę i to, czy burza jest subtropikalna.

GET {endpoint}/weather/tropical/storms/active/json?api-version=1.1

Parametry identyfikatora URI

Nazwisko W Wymagane Typ Opis
endpoint
path True

string (uri)

Nazwa hosta usługi Azure Maps. Użyj https://atlas.microsoft.com do Azure chmury publicznej. Aby skupić się na konkretnej Azure Maps geografii lub chmurze suwerennej, zobacz Azure Maps zakres geograficzny.

format
path True

JsonFormat

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

api-version
query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwisko Wymagane Typ Opis
x-ms-client-id

string

Wskazuje konto przeznaczone do użycia z modelem bezpieczeństwa Microsoft Entra ID. Ten unikalny identyfikator konta Azure Maps można uzyskać z API Azure Maps Account API na płaszczyźnie zarządzania. Więcej informacji na temat korzystania z Microsoft Entra ID zabezpieczeń w Azure Maps można znaleźć w Manage authentication in Azure Maps.

Odpowiedzi

Nazwisko Typ Opis
200 OK

ActiveStormResult

Żądanie zakończyło się pomyślnie.

Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

AadToken

Są to przepływy Microsoft Entra OAuth 2.0. W połączeniu z Azure zarządzaniem dostępem opartym na rolach może być używany do kontroli dostępu do Azure Maps API REST. Kontrola dostępu oparta na rolach Azure służy do wyznaczania dostępu do jednego lub więcej kont zasobów lub podzasobów Azure Maps. Każdy użytkownik, grupa lub jednostka usługi mogą 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 koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera 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.

Note

  • Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id w celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania usługami Maps.
  • Authorization URL jest specyficzna dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikalne adresy URL autoryzacji oraz konfiguracje Microsoft Entra ID.
  • Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana na podstawie 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 Web SDK usługi Azure Maps umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.
  • Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Platforma tożsamości Microsoft overview.

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

Zakresy

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

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenie 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.

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

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie poufnych aplikacji klienckich podejście do uzyskiwania dostępu do interfejsów API REST usługi Azure Maps, aby klucz mógł być bezpiecznie przechowywany.

Typ: apiKey
W: header

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji List SAS na 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 AZURE SDK lub interfejsów API REST.

Dzięki temu tokenowi 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 SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej zabezpieczony niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.

Typ: apiKey
W: header

Przykłady

Get Tropical Storm Active

Przykładowe żądanie

GET https://atlas.microsoft.com/weather/tropical/storms/active/json?api-version=1.1

Przykładowa odpowiedź

{
  "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"
    }
  ]
}

Definicje

Nazwisko Opis
ActiveStorm

Pojedyncza burza tropikalna, obecnie aktywna na całym świecie, powróciła jako jeden wpis w .ActiveStormResult.results Każdy wpis podsumowuje burzę z identyfikatorami potrzebnymi do odniesienia do niej w innych częściach API Get Tropical Storm – basen oceaniczny źródłowy (basinId), identyfikator wydany przez rząd (govId), oraz rok powstania (year) – wraz z oficjalną nazwą burzy (na przykład Hilda lub LUPIT) oraz flagami wskazującymi, czy burza jest nadal aktywna i czy jest klasyfikowana jako subtropikalna.

ActiveStormResult

Odpowiedź powróciła dzięki operacji Get Tropical Storm Active, która wymieniła wszystkie obecnie aktywne burze tropikalne na całym świecie, według raportów krajowych agencji prognozowania pogody. Każdy wpis w tablicy results zawiera ActiveStorm nazwę burzy, źródłowy basen oceaniczny, identyfikator wydany przez rząd, rok pochodzenia oraz aktywny i subtropikalny status. Gdy zbiór wyników jest zbyt duży, by zmieścić się w jednej odpowiedzi, przenosi nextLink adres URL do następnej strony.

BasinId

Wyliczenie basinId kategoryzuje różne baseny oceaniczne, w których mogą powstawać burze tropikalne. Każdemu basenowi przypisany jest unikalny identyfikator, który pomaga określić lokalizację źródła burzy.

ErrorAdditionalInfo

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

ErrorDetail

Szczegóły błędu.

ErrorResponse

Wspólna odpowiedź na błędy dla wszystkich API Azure Resource Manager zwraca szczegóły błędów dla nieudanych operacji. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

JsonFormat

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

ActiveStorm

Pojedyncza burza tropikalna, obecnie aktywna na całym świecie, powróciła jako jeden wpis w .ActiveStormResult.results Każdy wpis podsumowuje burzę z identyfikatorami potrzebnymi do odniesienia do niej w innych częściach API Get Tropical Storm – basen oceaniczny źródłowy (basinId), identyfikator wydany przez rząd (govId), oraz rok powstania (year) – wraz z oficjalną nazwą burzy (na przykład Hilda lub LUPIT) oraz flagami wskazującymi, czy burza jest nadal aktywna i czy jest klasyfikowana jako subtropikalna.

Nazwisko Typ Opis
basinId

BasinId

Basen oceaniczny, z którego wywodziła się tropikalna burza. Jedna z BasinId wartości to AL (Atlantyk), CP (Centralny Pacyfik), EP (Wschodni Pacyfik), NI (Północnoindyjski), NP (Północno-Zachodni Pacyfik), SI (Południowoindyjski) lub SP (Południowy Pacyfik). Na przykład EP dla burzy pochodzącej z wschodniego Pacyfiku.

govId

integer (int32)

Identyfikator nadany przez rząd burzy przez krajową agencję prognozowania pogody, unikalny w obrębie (basinId, ). year Użyj tego razem z basinId i year do odniesienia do burzy w innych operacjach Tropikalnej Burzy.

isActive

boolean

true jeśli burza tropikalna jest obecnie aktywna i nadal śledzona przez agencję wydającą; false jeśli nie jest już aktywna.

isSubtropical

boolean

true jeśli burza zostanie sklasyfikowana jako cyklon subtropikalny – system hybrydowy o cechach cyklonów tropikalnych i pozatropikalnych; false w przeciwnym razie.

name

string

Oficjalna nazwa burzy nadana przez odpowiednią krajową agencję prognozowania pogody – na przykład Hilda lub LUPIT. Burze, które nie zostały jeszcze formalnie nazwane, zwykle określane są przez tymczasowe określenie, takie jak TD 9E, lub słowo liczbowe, np. TWELVE.

year

string

Czterocyfrowy rok kalendarzowy, w którym powstała burza tropikalna – na przykład 2021. W połączeniu z basinId i govId, to jednoznacznie identyfikuje burzę na przestrzeni lat.

ActiveStormResult

Odpowiedź powróciła dzięki operacji Get Tropical Storm Active, która wymieniła wszystkie obecnie aktywne burze tropikalne na całym świecie, według raportów krajowych agencji prognozowania pogody. Każdy wpis w tablicy results zawiera ActiveStorm nazwę burzy, źródłowy basen oceaniczny, identyfikator wydany przez rząd, rok pochodzenia oraz aktywny i subtropikalny status. Gdy zbiór wyników jest zbyt duży, by zmieścić się w jednej odpowiedzi, przenosi nextLink adres URL do następnej strony.

Nazwisko Typ Opis
nextLink

string

URL do pobrania następnej strony wyników po stronicowaniu odpowiedzi, odpowiedni do nawigacji przez zbiory wyników zbyt duże, by zwrócić je w jednym wywołaniu. Pusty, gdy nie ma już stron.

results

ActiveStorm[]

Obecnie aktywne burze tropikalne, z jednym wejściem na burzę. Każdy ActiveStorm raportuje nazwę burzy (na przykład Hilda), źródłowy basen oceaniczny (np. EP dla wschodniego Pacyfiku), identyfikator wydany przez rząd i rok pochodzenia oraz czy burza jest nadal aktywna i czy jest klasyfikowana jako subtropikalna.

BasinId

Wyliczenie basinId kategoryzuje różne baseny oceaniczne, w których mogą powstawać burze tropikalne. Każdemu basenowi przypisany jest unikalny identyfikator, który pomaga określić lokalizację źródła burzy.

Wartość Opis
AL

Ocean Atlantycki. Ma kluczowe znaczenie dla śledzenia huraganów, które dotykają obie Ameryki i Karaiby. Jest to jeden z najbardziej aktywnych regionów dla burz tropikalnych.

CP

Środkowy Ocean Spokojny. Basen ten jest używany do sztormów dotykających Hawaje i okolice.

EP

Wschodni Ocean Spokojny. Basen ten śledzi sztormy uderzające w zachodnie wybrzeże obu Ameryk, w tym Meksyk i Amerykę Środkową. Przylega do basenu środkowego Pacyfiku.

NI

Północny Ocean Indyjski. Basen ten obejmuje burze dotykające Azję Południową, w tym kraje takie jak Indie i Bangladesz, które często są nawiedzane przez cyklony.

NP

Północno-zachodni Ocean Spokojny. Basen ten jest ważny dla śledzenia tajfunów, które dotykają Azję Wschodnią, w tym kraje takie jak Chiny, Japonia i Filipiny. Jest to najbardziej aktywny region burz tropikalnych na świecie.

SI

Południowy Ocean Indyjski. Basen ten, położony na południe od równika, obejmuje cyklony uderzające w Madagaskar, Afrykę i okoliczne regiony.

SP

Południowy Ocean Spokojny. Basen ten, położony na południe od równika, jest istotny dla cyklonów uderzających w Australię i wyspy południowego Pacyfiku.

ErrorAdditionalInfo

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

Nazwisko Typ Opis
info

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwisko 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

Wspólna odpowiedź na błędy dla wszystkich API Azure Resource Manager zwraca szczegóły błędów dla nieudanych operacji. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

Nazwisko Typ Opis
error

ErrorDetail

Obiekt błędu.

JsonFormat

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

Wartość Opis
json

format wymiany danych notacji obiektów JavaScript