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 https://atlas.microsoft.com/weather/tropical/storms/active/json?api-version=1.1
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
format
|
path | True |
Żądany format odpowiedzi. Obsługiwany jest tylko format |
|
|
api-version
|
query | True |
string |
Numer wersji interfejsu API usługi Azure Maps. |
Nagłówek żądania
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| x-ms-client-id |
string |
Wskazuje konto przeznaczone do użycia z modelem zabezpieczeń Microsoft Entra ID. Ten unikatowy identyfikator konta Azure Maps można uzyskać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby uzyskać więcej informacji na temat korzystania z zabezpieczeń Microsoft Entra ID w Azure Maps, zobacz Zarządzanie uwierzytelnianiem w Azure Maps. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
Wystąpił nieoczekiwany błąd. |
Zabezpieczenia
AADToken
Są to przepływy Microsoft Entra OAuth 2.0. Po połączeniu z dostępem opartym na rolach platformy Azure kontroli może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu usługi Azure Maps lub zasobów podrzędnych. 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 zapoznanie się z pojęciami dotyczącymi 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.
Notes
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-idw celu wskazania, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać z interfejsu API zarządzania Mapami Google .
Authorization URL jest specyficzna 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 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 konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.
- Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Microsoft identity platform overview.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresów
| Nazwa | Opis |
|---|---|
| https://atlas.microsoft.com/.default | 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:
query
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 zapytanie
GET https://atlas.microsoft.com/weather/tropical/storms/active/json?api-version=1.1
Przykładowa odpowiedź
{
"results": [
{
"year": "2021",
"basinId": "EP",
"name": "Hilda",
"isActive": true,
"isSubtropical": false,
"govId": 8
},
{
"year": "2021",
"basinId": "EP",
"name": "TD 9E",
"isActive": true,
"isSubtropical": false,
"govId": 9
},
{
"year": "2021",
"basinId": "NP",
"name": "TWELVE",
"isActive": true,
"isSubtropical": false,
"govId": 12
},
{
"year": "2021",
"basinId": "NP",
"name": "LUPIT",
"isActive": true,
"isSubtropical": false,
"govId": 13
},
{
"year": "2021",
"basinId": "NP",
"name": "FOURTEEN",
"isActive": true,
"isSubtropical": false,
"govId": 14
},
{
"year": "2021",
"basinId": "NP",
"name": "FIFTEEN",
"isActive": true,
"isSubtropical": false,
"govId": 15
}
]
}
Definicje
| Nazwa | Opis |
|---|---|
|
Active |
Zawiera istotne informacje o trwających burzach tropikalnych, jak są raportowane przez krajowe agencje prognozowania pogody. |
|
Active |
Obiekt ActiveStormResult dostarcza kompleksowych informacji o trwających burzach tropikalnych. Zawiera zestaw obiektów ActiveStorm , z których każdy opisuje konkretne atrybuty poszczególnych burz. Do tych atrybutów należą rządowy identyfikator burzy, identyfikator basenu, rok powstania, nazwa oraz status subtropikalny. |
|
basin |
Identyfikator zlewni |
|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
|
Error |
Szczegóły błędu. |
|
Error |
Odpowiedź na błąd |
|
Json |
Żądany format odpowiedzi. Obsługiwany jest tylko format |
ActiveStorm
Zawiera istotne informacje o trwających burzach tropikalnych, jak są raportowane przez krajowe agencje prognozowania pogody.
| Nazwa | Typ | Opis |
|---|---|---|
| basinId |
Kategoryzuje różne baseny oceaniczne, z których mogą powstawać burze tropikalne. Każdemu basenowi przypisany jest unikalny identyfikator, który pomaga określić lokalizację źródła burzy. Ważne identyfikatory basenów to AL, CP, EP, NI, NP, SI i SP. |
|
| govId |
integer (int32) |
Unikalny identyfikator przypisywany burzom tropikalnym przez krajowe agencje prognozowania pogody. Ten identyfikator pomaga dokładnie śledzić i odwoływać konkretne burze, w tym ich status, lokalizację i intensywność. |
| isActive |
boolean |
Wskazuje, czy burza tropikalna jest obecnie aktywna. Jeśli to prawda, burza jest aktywna; jeśli fałszywe, burza nie jest aktywna. |
| isSubtropical |
boolean |
Wartość zwrotna prawdziwa wskazuje, że burza jest klasyfikowana jako cyklon subtropikalny, co oznacza, że posiada zarówno cechy tropikalne, jak i pozatropikalne. |
| name |
string |
Nazwa burzy. |
| year |
string |
Określa rok, w którym wybuchła burza tropikalna. |
ActiveStormResult
Obiekt ActiveStormResult dostarcza kompleksowych informacji o trwających burzach tropikalnych. Zawiera zestaw obiektów ActiveStorm , z których każdy opisuje konkretne atrybuty poszczególnych burz. Do tych atrybutów należą rządowy identyfikator burzy, identyfikator basenu, rok powstania, nazwa oraz status subtropikalny.
| Nazwa | Typ | Opis |
|---|---|---|
| nextLink |
string |
Zawiera adres URL do pobrania następnej strony z wynikami, jeśli odpowiedź jest paginowana. Jest to przydatne, gdy odpowiedź jest zbyt duża, by zwrócić ją w jednym połączeniu, co pozwala użytkownikom przejrzeć wiele stron z wynikami. |
| results |
Szereg obiektów ActiveStorm , z których każdy dostarcza kluczowych informacji o trwającej burzy tropikalnej, według raportów krajowych agencji prognozowania pogody. |
basinId
Identyfikator zlewni
| 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.
| Nazwa | Typ | Opis |
|---|---|---|
| info |
object |
Dodatkowe informacje. |
| type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
| Nazwa | Typ | Opis |
|---|---|---|
| additionalInfo |
Dodatkowe informacje o błędzie. |
|
| code |
string |
Kod błędu. |
| details |
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 |
Obiekt błędu. |
JsonFormat
Żądany format odpowiedzi. Obsługiwany jest tylko format json.
| Wartość | Opis |
|---|---|
| json |