Weather - Get Severe Weather Alerts

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

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

GET {endpoint}/weather/severe/alerts/json?api-version=1.1&query={query}
GET {endpoint}/weather/severe/alerts/json?api-version=1.1&query={query}&language={language}&details={details}

Параметры URI

Имя В Обязательно Тип Описание
endpoint
path True

string

format
path True

JsonFormat

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

api-version
query True

string

minLength: 1

Версия API, используемая для данной операции.

query
query True

number[]

Применимый запрос, указанный как разделенная запятыми строка, состоящая из широты, за которой следует долгота, например "47.641268,-125679".

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

details
query

string

Верните полную информацию о предупреждениях о суровых погодных условиях. Доступные значения:

  • true - Возвращает полную информацию. По умолчанию возвращаются все данные.
  • false - Возвращает усеченную версию данных предупреждений, которая исключает полное описание деталей предупреждения для конкретной области (alertDetails).
language
query

string

Язык, в котором должны быть возвращены результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF, не учитывает регистр. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию.

Дополнительные сведения см. в поддерживаемых языках.

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

Имя Обязательно Тип Описание
x-ms-client-id

string

Указывает аккаунт, предназначенный для использования с моделью безопасности Microsoft Entra ID. Этот уникальный идентификатор для Azure Maps аккаунта можно получить с управляющего плана Azure Maps Account API. Для получения дополнительной информации об использовании Microsoft Entra ID безопасности в Azure Maps см. раздел Управление аутентификацией в Azure Maps.

Ответы

Имя Тип Описание
200 OK

SevereWeatherAlertsResult

Запрос выполнен успешно.

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

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

AadToken

Это Microsoft Entra OAuth 2.0 потоки. В сочетании с управлением Azure ролевым доступом он может использоваться для управления доступом к Azure Maps REST API. Ролевые контроли доступа Azure используются для обозначения доступа к одной или нескольким учетной записи ресурсов или подресурсам Azure Maps. Любой пользователь, группа или принципал сервиса может получить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений Azure Maps REST API.\n\nДля реализации сценариев рекомендуем ознакомиться с концепциями аутентификационные концепции. В заключение, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных контролировать доступ к определённым API и областям видимости.\n\n#### Примечания\n* Это определение безопасности требует использование заголовка x-ms-client-id для указания, к какому Azure Maps ресурсу приложение запрашивает доступ. Её можно получить через API управления Maps.\n* \nAuthorization URL специфичен для экземпляра публичного облака Azure. Облака Sovereign имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. \n* \nУправление доступом на основе ролей Azure настраивается с плоскости управления Azure через портал Azure, PowerShell, CLI, Azure SDKs или REST API.\n* \nИспользование Azure Maps Web SDK позволяет настраивать приложение на основе конфигурации для нескольких сценариев использования.\n* Для получения дополнительной информации о платформа удостоверений Майкрософт см. платформа удостоверений Майкрософт обзор.

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

Области

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

subscription-key

Это общий ключ, который создаётся при Создайте Azure Maps аккаунт в Azure-портале или с помощью PowerShell, CLI, Azure SDKs или REST API.\n\n С помощью этого ключа любое приложение может получить доступ ко всем REST API. Другими словами, этот ключ может использоваться как мастер-ключ на счете, на котором они выпущены.\n\n Для публично открытых приложений мы рекомендуем использовать подход confidential client applications для доступа к Azure Maps REST API, чтобы ваш ключ можно было безопасно хранить.

Тип: apiKey
В: header

SAS Token

Это токен общего доступа, созданный из операции List SAS на ресурсе Azure Maps/c0> через плоскость управления Azure через портал Azure, PowerShell, CLI, Azure SDKs или REST API.\n\n С помощью этого токена любое приложение имеет право на доступ с помощью Azure ролевые контроли доступа и тонкий контроль истечения срока действия, скорости и региона использования конкретного токена. Другими словами, SAS Token может использоваться для того, чтобы приложения могли управлять доступом более защищённо, чем общий ключ.\n\n Для публично открытых приложений мы рекомендуем настроить конкретный список разрешённых источников на ресурсе аккаунта Map , чтобы ограничить злоупотребления рендерингом и регулярно продлевать токен SAS.

Тип: apiKey
В: header

Примеры

Successfully retrieve severe weather alerts

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

GET {endpoint}/weather/severe/alerts/json?api-version=1.1&query=48.057,-81.091

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

{
  "results": [
    {
      "description": {
        "english": "Heat Warning",
        "localized": "Heat Warning"
      },
      "alertAreas": [
        {
          "name": "Kirkland Lake - Englehart",
          "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",
          "endTime": "2020-07-02T07:16:03+00:00",
          "latestStatus": {
            "english": "Continue",
            "localized": "Continue"
          },
          "startTime": "2020-06-29T19:44:00+00:00",
          "summary": "Heat Warning in effect until Thursday, 3:16 AM EDT.  Source: Environment Canada"
        }
      ],
      "alertId": 242621,
      "category": "NON-PRECIPITATION",
      "countryCode": "CA",
      "priority": 31,
      "source": "Environment Canada",
      "sourceId": 3
    },
    {
      "description": {
        "english": "Heat Warning",
        "localized": "Heat Warning"
      },
      "alertAreas": [
        {
          "name": "Kirkland Lake - Englehart",
          "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",
          "endTime": "2020-07-02T01:25:59+00:00",
          "latestStatus": {
            "english": "New",
            "localized": "New"
          },
          "startTime": "2020-07-01T09:25:59+00:00",
          "summary": "Heat Warning in effect until 9:25 PM EDT.  Source: Environment Canada"
        }
      ],
      "alertId": 242633,
      "category": "NON-PRECIPITATION",
      "countryCode": "CA",
      "priority": 31,
      "source": "Environment Canada",
      "sourceId": 3
    }
  ]
}

Определения

Имя Описание
AlertArea

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

ErrorAdditionalInfo

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

ErrorDetail

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

ErrorResponse

Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа об ошибках OData.).

JsonFormat

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

LatestStatus

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

LatestStatusKeyword

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

SevereWeatherAlert

Информация о предупреждении о суровой погоде.

SevereWeatherAlertDescription

Описание предупреждения о суровой погоде.

SevereWeatherAlertsResult

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

AlertArea

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

Имя Тип Описание
alertDetails

string

Полная информация, связанная с предупреждением. Возвращено, если details=True. Это поле всегда возвращается на выбранном языке провайдером, а Azure Maps возвращает только то, что создаёт провайдер. Обратите внимание, что некоторые страны/регионы могут предлагать свой родной язык и английский. Параметр языка не применимо к этой области.

alertDetailsLanguageCode

string

Язык домена alertDetails. Это поле помогает указать, что язык параметра alertDetails может отличаться от запрашиваемого параметра language. Возвращено, если details=True. Код языка был получен из кодов ISO 639-1 Alpha-2.

endTime

string (date-time)

Дата и время окончания или окончания предупреждения — в [ISO 8601](https://en.wikipedia.org/wiki/ISO_format (yyyy-mm-ddThh:mm:ss-hh:mm). Например, 2025-04-29T07:00:00-07:00. Если предупреждение охватывает несколько часовых поясов, ответ предоставит местное время, соответствующее запрошиваемым координатам.

latestStatus

LatestStatus

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

name

string

Название области, на которую распространяется предупреждение. Местоположение, которое было запрошено, попадает в зону тревоги.

startTime

string (date-time)

Дата начала и время оповещения в формате ISO 8601 , например, 2019-10-27T19:39:57-08:00. Если оповещение пересекает несколько часовых поясов, в ответе возвращается время по местному времени до запрошенного координатного местоположения.

summary

string

Текст с кратким изложением оповещения в возвращенной области.

ErrorAdditionalInfo

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

Имя Тип Описание
info

Дополнительные сведения.

type

string

Дополнительный тип сведений.

ErrorDetail

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

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

ErrorDetail[]

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

message

string

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

target

string

Целевой объект ошибки.

ErrorResponse

Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа об ошибках OData.).

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

JsonFormat

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

Значение Описание
json

формат обмена данными для объектов JavaScript

LatestStatus

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

Имя Тип Описание
english

LatestStatusKeyword

Ключевое слово последнего статуса для оповещения на английском языке (en-US).

localized

string

Последнее ключевое слово status для оповещения на указанном языке. По умолчанию возвращается на английском языке (en-US).

LatestStatusKeyword

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

Значение Описание
Cancel

Указывает, что оповещение было отменено до первоначально запланированного срока его действия.

Continue

Указывает, что оповещение было обновлено с момента его первоначальной отправки, но не было внесено никаких изменений в alertDetails, startTime, endTime, или class.

Correct

Указывает, что предупреждение было изменено для исправления предыдущей ошибки.

Expire

Указывает, что срок действия оповещения истек и оно больше не активно.

Extend

Указывает, что предупреждение было продлено по продолжительности, области или и тому, и другому с момента его первоначальной отправки.

New

Состояние оповещения при первой выдаче.

Update

Указывает, что предупреждение было изменено с момента его первоначальной выдачи.

Upgrade

Указывает, что предупреждение было повышено до более высокого класса или категории с момента первой выдачи.

SevereWeatherAlert

Информация о предупреждении о суровой погоде.

Имя Тип Описание
alertAreas

AlertArea[]

Информация о предупреждении, относящемся к проблемной области.

alertId

integer (int32)

Уникальный числовой идентификатор для оповещения о погоде.

category

string

Категория оповещения.

class

string

Классификация оповещения. Это поле доступно не для всех стран и поэтому не всегда возвращается.

countryCode

string

2-символьный код страны ISO 3166-1 Alpha-2, например, "US".

description

SevereWeatherAlertDescription

Описание оповещения.

disclaimer

string

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

level

string

Серьезность оповещения. Это поле доступно не для всех стран и поэтому не всегда возвращается.

priority

integer (int32)

Число, обозначающее важность или порядок ранжирования данного оповещения в стране или регионе, в котором оно было отправлено. Меньшее число означает более высокий приоритет. Например, 1 является наивысшим приоритетом. Это число варьируется в зависимости от страны или региона и может меняться со временем по мере развития систем оповещения в каждой стране/регионе.

source

string

Поставщик предупреждающей информации. По умолчанию исходный код возвращается на английском языке (en-US). Предупреждения поступают от официальных государственных метеорологических агентств и ведущих мировых поставщиков метеорологических предупреждений.

sourceId

integer (int32)

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

SevereWeatherAlertDescription

Описание предупреждения о суровой погоде.

Имя Тип Описание
english

string

Описание оповещения на английском языке (en-US).

localized

string

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

SevereWeatherAlertsResult

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

Имя Тип Описание
results

SevereWeatherAlert[]

Список всех предупреждений о суровых погодных условиях для запрашиваемого местоположения.