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

Weather - Get Severe Weather Alerts

  • Ссылка
Service:
Maps
API Version:
1.1

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

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

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

GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query={query}
With optional parameters: 
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 ID. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в 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.

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

Примечания

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

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

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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

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

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

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

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

Примеры

Successfully retrieve severe weather alerts

Sample Request

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

Sample Response

Status code:
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 возвращает только то, что создано поставщиком. Обратите внимание, что в некоторых странах или регионах может быть свой родной язык и английский. Параметр language не применяется к этому полю.
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

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

JsonFormat

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

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

string

Формат обмена данными нотации объектов JavaScript

LatestStatus

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

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

LatestStatusKeyword

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

string

Последнее состояние ключевое слово для оповещения на указанном языке. По умолчанию возвращается на английском языке (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[]

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