Weather - Get Tropical Storm Search

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.1

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

Interfejs Get Tropical Storm Search API jest żądaniem HTTP GET , które zwraca listę burzy tropikalnych wystawionych przez instytucje rządowe według roku, identyfikatora basenu i identyfikatora rządu. Informacje o burzach tropikalnych obejmują identyfikator rządu, identyfikator basenu, stan, rok, nazwę i jeśli jest podtropiczny.

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

Z parametrami opcjonalnymi:

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

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.
year	query	True	integer int32	Rok cyklonów
basinId	query		basinId	Identyfikator basenu
govId	query		integer int32	Identyfikator burzy rządowej

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ń identyfikatora Entra firmy Microsoft w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki.

Odpowiedzi

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

Zabezpieczenia

AADToken

Są to przepływy protokołu Microsoft Entra OAuth 2.0 . Po połączeniu z kontrolą dostępu opartą na rolach platformy Azure można użyć jej 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 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ęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi 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 w celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać z poziomu interfejsu API zarządzania usługami Maps .

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 poziomu 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 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 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ółużytkowany 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.

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do wszystkich interfejsów 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 podejścia do poufnych aplikacji klienckich w celu uzyskania 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 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 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 oraz 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 bezpieczny 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 SAS.

Typ: apiKey
W: header

Przykłady

Get Tropical Storm Search

Get Tropical Storm Search With Three Properties

Get Tropical Storm Search

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "results": [
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 1,
      "name": "Ana",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 2,
      "name": "Bill",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 3,
      "name": "Claudette",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 4,
      "name": "Danny",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 5,
      "name": "Elsa",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 6,
      "name": "Fred",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 7,
      "name": "Grace",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 8,
      "name": "Henri",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 9,
      "name": "Ida",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 10,
      "name": "Kate",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 11,
      "name": "Julian",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 12,
      "name": "Larry",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 13,
      "name": "Mindy",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 14,
      "name": "Nicholas",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 15,
      "name": "ODETTE",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 16,
      "name": "Peter",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 17,
      "name": "Rose",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 18,
      "name": "Sam",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 19,
      "name": "Teresa",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 20,
      "name": "Victor",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 21,
      "name": "Wanda",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    }
  ]
}

Get Tropical Storm Search With Three Properties

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "results": [
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 1,
      "name": "Ana",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    }
  ]
}

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
JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko `json` format.
StormSearchResult	Wyszukiwanie burz wystawionych przez rząd
StormSearchResultItem	Wystawione przez rząd aktywne wydarzenie burza

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 error.

JsonFormat

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

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

StormSearchResult

Wyszukiwanie burz wystawionych przez rząd

Nazwa	Typ	Opis
nextLink	string	To link do następnej strony zwróconych funkcji. Jeśli jest to ostatnia strona, nie ma tego pola.
results	StormSearchResultItem[]	Wyszukiwanie burz wystawionych przez rząd

StormSearchResultItem

Wystawione przez rząd aktywne wydarzenie burza

Nazwa	Typ	Opis
basinId	basinId	Identyfikator basenu (AL, EP, SI, NI, CP, NP, SP)
govId	integer	Identyfikator burzy rządowej. Będzie to zgodne z liczbą depresji.
isActive	boolean	Prawda, jeśli depresja została niedawno zaktualizowana.
isRetired	boolean	Prawda, jeśli nazwa burzy została trwale wycofana w basenie źródłowym.
isSubtropical	boolean	Prawda, gdy depresja jest klasyfikowana jako cyklon subtropowy.
name	string	Nazwa depresji.
year	string	Rok pochodzenia

Udostępnij za pośrednictwem

Weather - Get Tropical Storm Search

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

AADToken

Uwagi

Zakresy

subscription-key

SAS Token

Przykłady

Get Tropical Storm Search

Przykładowe żądanie

Przykładowa odpowiedź

Get Tropical Storm Search With Three Properties

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

basinId

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat

StormSearchResult

StormSearchResultItem

Dodatkowe zasoby