Weather - Get Severe Weather Alerts

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.1

Służy do uzyskiwania informacji na temat poważnych warunków pogodowych, takich jak huragany, burze, powodzie, błyskawica, fale upałów lub pożary lasów dla danej lokalizacji.

Poważne zjawisko pogodowe może znacząco wpłynąć na nasze codzienne życie i działalność biznesową. Na przykład poważne warunki pogodowe, takie jak burze tropikalne, wysokie wiatry lub powodzie, mogą zamknąć drogi i zmusić firmy logistyczne do przekierowania swojej floty powodując opóźnienia w dotarciu do miejsc docelowych i zerwanie łańcucha zimnych produktów spożywczych.

Interfejs Get Severe Weather Alerts API jest żądaniem HTTP GET , które zwraca poważne alerty pogodowe dostępne na całym świecie zarówno z oficjalnych rządowych agencji meteorologicznych, jak i wiodących globalnych dla regionalnych dostawców alertów pogodowych. Usługa może zwracać szczegóły, takie jak typ alertu, kategoria, poziom i szczegółowy opis aktywnych poważnych alertów dotyczących żądanej lokalizacji, takich jak huragany, burze, pioruny, fale upałów lub pożary lasów. Aby uzyskać więcej informacji, zobacz Żądanie poważnych alertów pogodowych

GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query={query}

Z parametrami opcjonalnymi:

GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query={query}&language={language}&details={details}

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.
query	query	True	number[]	Odpowiednie zapytanie określone jako ciąg rozdzielany przecinkami składa się z szerokości geograficznej, po której następuje długość geograficzna, np. "47.641268,-122.125679".
details	query		string	Zwróć pełne szczegóły dotyczące poważnych alertów pogodowych. Dostępne wartości to `true` — Zwraca pełne szczegóły. Domyślnie wszystkie szczegóły są zwracane. `false` — Zwraca obciętą wersję danych alertów, która wyklucza pełny opis szczegółów alertu (`alertDetails`).
language	query		string	Język, w którym powinny być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, bez uwzględniania wielkości liter. Gdy dane w określonym języku nie są dostępne dla określonego pola, używany jest język domyślny. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki .

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	SevereWeatherAlertsResult	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 SYGNATURy dostępu współdzielonego.

Typ: apiKey
W: header

Przykłady

Successfully retrieve severe weather alerts

Przykładowe żądanie

HTTP

GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query=48.057,-81.091

Przykładowa odpowiedź

Kod stanu:: 200

{
  "results": [
    {
      "countryCode": "CA",
      "alertId": 242621,
      "description": {
        "localized": "Heat Warning",
        "english": "Heat Warning"
      },
      "category": "NON-PRECIPITATION",
      "priority": 31,
      "source": "Environment Canada",
      "sourceId": 3,
      "alertAreas": [
        {
          "name": "Kirkland Lake - Englehart",
          "summary": "Heat Warning in effect until Thursday, 3:16 AM EDT.  Source: Environment Canada",
          "startTime": "2020-06-29T19:44:00+00:00",
          "endTime": "2020-07-02T07:16:03+00:00",
          "latestStatus": {
            "localized": "Continue",
            "english": "Continue"
          },
          "alertDetails": "\nA heat event continues through Thursday.\n\nDaytime high temperatures in the low thirties with overnight lows near 18 degrees Celsius are expected to continue until Thursday. Humidex values are expected to reach between 36 and 40 today. Cooler air will move into the region Thursday night. \n\nPlease refer to your public forecast for further details on expected temperatures.\n\nHot and humid air can also bring deteriorating air quality and can result in the air quality health index to approach the high risk category.\n\n###\n\nExtreme heat affects everyone.\n\nThe risks are greater for young children, pregnant women, older adults, people with chronic illnesses and people working or exercising outdoors.\n\nWatch for the effects of heat illness: swelling, rash, cramps, fainting, heat exhaustion, heat stroke and the worsening of some health conditions.\n\nPlease continue to monitor alerts and forecasts issued by Environment Canada. To report severe weather, send an email to ONstorm@canada.ca or tweet reports using #ONStorm.\n",
          "alertDetailsLanguageCode": "en-CA"
        }
      ]
    },
    {
      "countryCode": "CA",
      "alertId": 242633,
      "description": {
        "localized": "Heat Warning",
        "english": "Heat Warning"
      },
      "category": "NON-PRECIPITATION",
      "priority": 31,
      "source": "Environment Canada",
      "sourceId": 3,
      "alertAreas": [
        {
          "name": "Kirkland Lake - Englehart",
          "summary": "Heat Warning in effect until 9:25 PM EDT.  Source: Environment Canada",
          "startTime": "2020-07-01T09:25:59+00:00",
          "endTime": "2020-07-02T01:25:59+00:00",
          "latestStatus": {
            "localized": "New",
            "english": "New"
          },
          "alertDetails": "\nA heat event is expected through Thursday.  \n\nDaytime high temperatures in the low thirties on Wednesday and Thursday with overnight lows near 18 degrees Celsius are expected. This heat event may be extended into the weekend with daytime high temperatures near 30 degrees Celsius. \n\nPlease refer to your public forecast for further details on expected temperatures.  \n\nHot and humid air can also bring deteriorating air quality and can result in the Air Quality Health Index to approach the high risk category.\n\n###\n\nExtreme heat affects everyone.\n\nThe risks are greater for young children, pregnant women, older adults, people with chronic illnesses and people working or exercising outdoors.\n\nPlease continue to monitor alerts and forecasts issued by Environment Canada. To report severe weather, send an email to ONstorm@canada.ca or tweet reports using #ONStorm.\n",
          "alertDetailsLanguageCode": "en-CA"
        }
      ]
    }
  ]
}

Definicje

Nazwa	Opis
AlertArea	Informacje o poważnym alercie pogodowym wydanym w dotkniętych obszarach. Jeśli wiele alertów jest aktywnych w tej samej lokalizacji, alerty zostaną zwrócone w kolejności w `priority` odpowiedzi interfejsu API, a alert o najwyższym priorycie jest zwracany w górnej części odpowiedzi.
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.
LatestStatus	Najnowszy stan alertu w bieżącym obszarze.
LatestStatusKeyword	Słowo kluczowe dla najnowszego stanu alertu.
SevereWeatherAlert	Informacje o poważnym alercie pogodowym.
SevereWeatherAlertDescription	Opis alertu o ciężkiej pogodzie.
SevereWeatherAlertsResult	Ten obiekt jest zwracany z pomyślnego wywołania Get Severe Weather Alerts.

AlertArea

Informacje o poważnym alercie pogodowym wydanym w dotkniętych obszarach. Jeśli wiele alertów jest aktywnych w tej samej lokalizacji, alerty zostaną zwrócone w kolejności w priority odpowiedzi interfejsu API, a alert o najwyższym priorycie jest zwracany w górnej części odpowiedzi.

Nazwa	Typ	Opis
alertDetails	string	Pełne szczegóły skojarzone z alertem. Zwrócone, jeśli `details`=True. To pole jest zawsze zwracane w wybranych językach przez dostawcę wystawiającego, a usługa Azure Maps zwraca tylko to, co zostało utworzone przez dostawcę. Należy pamiętać, że niektóre kraje/regiony mogą oferować swój język macierzysty i angielski. Parametr języka nie będzie stosowany do tego pola.
alertDetailsLanguageCode	string	Język obiektu `alertDetails`. To pole pomaga wskazać, że język elementu `alertDetails` może różnić się od żądanego parametru języka. Zwrócone, jeśli `details`=True. Kod języka pochodzi z kodów ISO 639-1 Alpha-2.
endTime	string	Data i godzina zakończenia alertu w formacie ISO 8601, na przykład 2019-10-27T19:39:57-08:00. Jeśli alert przekroczy wiele stref czasowych, zwracany czas odpowiedzi to czas lokalny do żądanej lokalizacji współrzędnych.
latestStatus	LatestStatus	Najnowszy stan alertu w bieżącym obszarze.
name	string	Nazwa obszaru, którego dotyczy alert. Żądana lokalizacja znajduje się w obszarze alertu.
startTime	string	Data i godzina rozpoczęcia alertu w formacie ISO 8601, na przykład 2019-10-27T19:39:57-08:00. Jeśli alert przekroczy wiele stref czasowych, zwracany czas odpowiedzi to czas lokalny do żądanej lokalizacji współrzędnych.
summary	string	Tekst podsumowujący alert w zwróconym obszarze.

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

LatestStatus

Najnowszy stan alertu w bieżącym obszarze.

Nazwa	Typ	Opis
english	LatestStatusKeyword	Najnowsze słowo kluczowe stanu alertu w języku angielskim (en-US).
localized	string	Najnowsze słowo kluczowe stanu alertu w określonym języku. Domyślnie jest zwracany w języku angielskim (en-US).

LatestStatusKeyword

Słowo kluczowe dla najnowszego stanu alertu.

Nazwa	Typ	Opis
Cancel	string	"Anuluj" — alert został anulowany przed oryginalnym czasem wygaśnięcia.
Continue	string	"Kontynuuj" — alert został zaktualizowany od czasu jego początkowego wystawiania, ale nie wprowadzono żadnych zmian w `alertDetails`, `startTime`, `endTime`lub `class`.
Correct	string	"Odpowiedź prawidłowa" — alert został zmodyfikowany w celu poprawienia poprzedniego błędu.
Expire	string	"Wygaśnięcie" — alert wygasł i nie jest już aktywny.
Extend	string	"Rozszerz" — alert został przedłużony w czasie, w obszarze lub w obu od czasu jego początkowej emisji.
New	string	"Nowy" — stan alertu podczas wystawiania początkowego.
Update	string	"Aktualizuj" — alert został zaktualizowany od czasu jego początkowego wystawienia.
Upgrade	string	"Uaktualnij" — alert został uaktualniony do wyższej klasy lub kategorii od momentu jego początkowego wystawienia.

SevereWeatherAlert

Informacje o poważnym alercie pogodowym.

Nazwa	Typ	Opis
alertAreas	AlertArea[]	Informacje o alercie specyficznym dla obszarów, których dotyczy problem.
alertId	integer	Unikatowy identyfikator liczbowy alertu dotyczącego pogody.
category	string	Kategoria alertu.
class	string	Klasyfikacja alertu. To pole nie jest dostępne dla wszystkich krajów i dlatego nie zawsze zwracane.
countryCode	string	2-znakowy kod kraju ISO 3166-1 Alfa-2, na przykład "USA".
description	SevereWeatherAlertDescription	Opis alertu.
disclaimer	string	Zastrzeżenie dotyczące źródła informacji o alercie. To pole nie jest zawsze dostępne. Na przykład wyłączenie odpowiedzialności może zawierać szczegółowe informacje o opóźnieniach lub potencjalnych problemach związanych z alarmem.
level	string	Poziom ważności alertu. To pole nie jest dostępne dla wszystkich krajów i dlatego nie zawsze zwracane.
priority	integer	Numer oznaczający ważność lub kolejność klasyfikacji danego alertu w kraju/regionie, z którego pochodzi. Niższa liczba oznacza wyższy priorytet. Na przykład 1 jest najwyższym priorytetem. Liczba różni się w zależności od kraju/regionu i może się zmieniać wraz z upływem czasu, gdy każdy kraj/region ewoluuje w swoich systemach alertów.
source	string	Dostawca informacji o alercie. Domyślnie źródło jest zwracane w języku angielskim (en-US). Alerty pochodzą z oficjalnych rządowych agencji meteorologicznych i wiodących globalnych dostawców alertów pogodowych.
sourceId	integer	Identyfikator liczbowy skojarzony z nazwą dostawcy źródłowego danych alertu.

SevereWeatherAlertDescription

Opis alertu o ciężkiej pogodzie.

Nazwa	Typ	Opis
english	string	Opis alertu w języku angielskim (en-US).
localized	string	Opis alertu w określonym języku. Domyślnie angielski (en-US) jest zwracany, jeśli parametr języka nie jest określony w żądaniu.

SevereWeatherAlertsResult

Ten obiekt jest zwracany z pomyślnego wywołania Get Severe Weather Alerts.

Nazwa	Typ	Opis
results	SevereWeatherAlert[]	Lista wszystkich poważnych alertów pogodowych dla żądanej lokalizacji.

Udostępnij za pośrednictwem