Weather - Get Severe Weather Alerts

Ссылка

Служба:: Maps

Версия API:: 1.1

Используйте для получения информации о сложных погодных условиях, таких как ураганы, грозы, наводнения, молнии, волны тепла или лесные пожары для определенного места.

Суровые погодные явления могут значительно повлиять на нашу повседневную жизнь и бизнес-операции. Например, тяжелые погодные условия, такие как тропические штормы, сильный ветер или наводнение, могут закрыть дороги и заставить логистические компании перенаправить свой флот, что приводит к задержкам в достижении пунктов назначения и нарушению холодной цепочки охлажденных продуктов питания.

Get Severe Weather Alerts API — это HTTP-запросGET, который возвращает оповещения о неблагоприятных погодных условиях, доступные по всему миру как от официальных государственных метеорологических агентств, так и от ведущих глобальных и региональных поставщиков оповещений о погоде. Служба может возвращать такие сведения, как тип оповещения, категория, уровень и подробное описание активных серьезных оповещений для запрошенного расположения, таких как ураганы, грозы, молнии, волны тепла или лесные пожары. Дополнительные сведения см. в разделе Запрос оповещений о неблагоприятных погодных условиях.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	JsonFormat	Требуемый формат ответа. Поддерживается только формат `json`.
api-version	query	True	string	Номер версии API Azure Maps
query	query	True	number[]	Применимый запрос, указанный в виде строки, разделенной запятыми, состоящей из широты и долготы, например "47,641268,-122.125679".
details	query		string	Возврат полных сведений об оповещениях о суровых погодных условиях. Доступные значения: `true` — возвращает полные сведения. По умолчанию возвращаются все сведения. `false` — возвращает усеченную версию данных оповещений, которая исключает полное описание сведений об оповещении для конкретной области (`alertDetails`).
language	query		string	Язык, на котором должны возвращаться результаты поиска. Должен быть одним из поддерживаемых языковых тегов IETF без учета регистра. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию. Дополнительные сведения см. в разделе Поддерживаемые языки .

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Идентификатора Microsoft Entra. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи плоскости управления Azure Maps. Инструкции по использованию безопасности Microsoft Entra ID в Azure Maps см. в следующих статьях .

Ответы

Имя	Тип	Описание
200 OK	SevereWeatherAlertsResult	ХОРОШО
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

Безопасность

AADToken

Это потоки Microsoft Entra OAuth 2.0 . В сочетании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к REST API Azure Maps. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям ресурсов Azure Maps или вложенным ресурсам. Любому пользователю, группе или субъекту-службе может быть предоставлен доступ через встроенную или пользовательскую роль, состоящую из одного или нескольких разрешений для REST API Azure Maps.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, которые могут управлять доступом к определенным API и областям.

Примечания

Это определение безопасности требует использования заголовка x-ms-client-id , чтобы указать, к какому ресурсу Azure Maps приложение запрашивает доступ. Его можно получить из API управления Картами .

объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации идентификатора Microsoft Entra. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портала Azure, PowerShell, CLI, пакетов Sdk для Azure или REST API. * Использование веб-пакета SDK Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

Дополнительные сведения о платформе удостоверений Майкрософт см. в статье Обзор платформы удостоверений Майкрософт.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, который подготавливается при создании учетной записи Azure Maps на портале Azure или с помощью PowerShell, CLI, пакетов AZURE SDK или REST API.

С помощью этого ключа любое приложение может получить доступ ко всем REST API. Иными словами, этот ключ можно использовать в качестве главного ключа в учетной записи, в которую они выдаются.

Для общедоступных приложений мы рекомендуем использовать подход конфиденциальных клиентских приложений для доступа к REST API Azure Maps, чтобы ваш ключ можно было безопасно хранить.

Тип: apiKey
В: query

SAS Token

Это маркер подписанного URL-адреса, который создается из операции SAS list в ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов использования конкретного маркера. Иными словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи map , чтобы ограничить использование маркера SAS и регулярно обновлять маркер SAS.

Тип: apiKey
В: header

Примеры

Successfully retrieve severe weather alerts

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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"
        }
      ]
    }
  ]
}

Определения

Имя	Описание
AlertArea	Сведения об оповещении о суровых погодных условиях, выдаваемых в пострадавших районах. Если для одного расположения активно несколько оповещений, они будут возвращены в порядке `priority` ответа API, а оповещение с наивысшим приоритетом возвращается в верхней части ответа.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
JsonFormat	Требуемый формат ответа. Поддерживается только формат `json`.
LatestStatus	Последнее состояние оповещения в текущей области.
LatestStatusKeyword	Ключевое слово для последнего состояния оповещения.
SevereWeatherAlert	Сведения об оповещении о суровых погодных условиях.
SevereWeatherAlertDescription	Описание оповещения о суровых погодных условиях.
SevereWeatherAlertsResult	Этот объект возвращается из успешного вызова Get Severe Weather Alerts.

AlertArea

Сведения об оповещении о суровых погодных условиях, выдаваемых в пострадавших районах. Если для одного расположения активно несколько оповещений, они будут возвращены в порядке priority ответа API, а оповещение с наивысшим приоритетом возвращается в верхней части ответа.

Имя	Тип	Описание
alertDetails	string	Полные сведения, связанные с оповещением. Возвращается, если `details`=True. Это поле всегда возвращается на языках, выбранных поставщиком-поставщиком, а Azure Maps возвращает только то, что создано поставщиком. Обратите внимание, что в некоторых странах или регионах может быть свой родной язык и английский. Параметр языка не применяется к этому полю.
alertDetailsLanguageCode	string	Язык .`alertDetails` Это поле позволяет указать, что язык `alertDetails` может отличаться от запрошенного параметра языка. Возвращается, если `details`=True. Код языка был получен из кодов ISO 639-1 Alpha-2.
endTime	string	Дата и время окончания оповещения в формате ISO 8601, например 2019-10-27T19:39:57-08:00. Если оповещение пересекает несколько часовых поясов, то возвращаемое время в ответе — это местное время для запрошенного координатного расположения.
latestStatus	LatestStatus	Последнее состояние оповещения в текущей области.
name	string	Имя области, на которую влияет оповещение. Запрошенная область относится к области оповещений.
startTime	string	Дата и время начала оповещения в формате ISO 8601, например 2019-10-27T19:39:57-08:00. Если оповещение пересекает несколько часовых поясов, то возвращаемое время в ответе — это местное время для запрошенного координатного расположения.
summary	string	Текст, обобщающий оповещение в возвращенной области.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект error.

JsonFormat

Требуемый формат ответа. Поддерживается только формат json.

Имя	Тип	Описание
json	string	Формат обмена данными нотации объектов JavaScript

LatestStatus

Последнее состояние оповещения в текущей области.

Имя	Тип	Описание
english	LatestStatusKeyword	Ключевое слово latest status для оповещения на английском языке (en-US).
localized	string	Ключевое слово latest status для оповещения на указанном языке. По умолчанию возвращается на английском языке (en-US).

LatestStatusKeyword

Ключевое слово для последнего состояния оповещения.

Имя	Тип	Описание
Cancel	string	"Отмена" — оповещение было отменено до первоначального срока действия.
Continue	string	"Продолжить" — оповещение было обновлено с момента его первоначальной выдачи, но изменения в , `startTime`, `endTime`или `class`не были внесены`alertDetails`.
Correct	string	"Правильно" — оповещение было изменено для исправления предыдущей ошибки.
Expire	string	"Срок действия" — оповещение истекло и больше не активно.
Extend	string	"Продлить" — оповещение было продлено во времени, в области или в обоих областях с момента его первоначальной выдачи.
New	string	"Создать" — состояние оповещения при первоначальной выдаче.
Update	string	"Обновление" — оповещение было обновлено с момента его первоначальной выдачи.
Upgrade	string	"Обновление" — оповещение было обновлено до более высокого класса или категории с момента его первоначальной выдачи.

SevereWeatherAlert

Сведения об оповещении о суровых погодных условиях.

Имя	Тип	Описание
alertAreas	AlertArea[]	Сведения об оповещении, относящиеся к затронутым областям.
alertId	integer	Уникальный числовой идентификатор оповещения о погоде.
category	string	Категория оповещения
class	string	Классификация оповещения. Это поле доступно не для всех стран и поэтому возвращается не всегда.
countryCode	string	2-символьный код страны ISO 3166-1 Alpha-2, например "US".
description	SevereWeatherAlertDescription	Описание оповещения.
disclaimer	string	Заявление об отказе от ответственности в отношении источника сведений об оповещении. Это поле не всегда доступно. Например, заявление об отказе может включать сведения о задержках или потенциальных проблемах, связанных с будильником.
level	string	Серьезность оповещения. Это поле доступно не для всех стран и поэтому возвращается не всегда.
priority	integer	Номер, обозначающий важность или порядок ранжирования заданного оповещения в стране или регионе, которые оно было создано. Меньшее число означает более высокий приоритет. Например, 1 является наивысшим приоритетом. Это число зависит от страны или региона и может меняться с течением времени по мере развития системы оповещений для каждой страны или региона.
source	string	Поставщик сведений об оповещении. По умолчанию источник возвращается на английском языке (en-US). Оповещения от официальных правительственных метеорологических учреждений и ведущих мировых поставщиков оповещений о погоде.
sourceId	integer	Числовый идентификатор, связанный с именем поставщика источника данных оповещения.

SevereWeatherAlertDescription

Описание оповещения о суровых погодных условиях.

Имя	Тип	Описание
english	string	Описание оповещения на английском языке (en-US).
localized	string	Описание оповещения на указанном языке. По умолчанию возвращается английский (en-US), если параметр языка не указан в запросе.

SevereWeatherAlertsResult

Этот объект возвращается из успешного вызова Get Severe Weather Alerts.

Имя	Тип	Описание
results	SevereWeatherAlert[]	Список всех оповещений о суровых погодных условиях для запрашиваемого расположения.

Поделиться через