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


Weather - Get Minute Forecast

Используйте для получения поминутного прогноза на ближайшие 120 минут с интервалом в 1, 5 и 15 минут.

Get Minute Forecast API — это HTTP-запросGET, который возвращает поминутные прогнозы для заданного местоположения на следующие 120 минут. Пользователи могут запрашивать прогноз погоды с интервалом в 1, 5 и 15 минут. Ответ будет содержать такие детали, как тип осадков (включая дождь, снег или их смесь), время начала и значение интенсивности осадков (дБЗ). Дополнительные сведения см. в разделе Запрос поминутных данных прогноза погоды.

GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query={query}
GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query={query}&interval={interval}&language={language}

Параметры URI

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

JsonFormat

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

api-version
query True

string

Номер версии API Azure Maps.

query
query True

number[]

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

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

interval
query

integer

Указывает временной интервал в минутах для возвращаемого прогноза погоды. Поддерживаемые значения:

  • 1 - Получение прогноза с интервалом в 1 минуту. Возвращается по умолчанию.
  • 5 - Получение прогнозов с 5-минутными интервалами.
  • 15 - Получение прогнозов с 15-минутными интервалами.
language
query

string

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

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

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

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

string

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

Ответы

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

MinuteForecastResult

ХОРОШО

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, пакетов SDK Azure или REST API.

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

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

Тип: apiKey
В: query

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

Successfully retrieve minute-by-minute forecasts for a given location

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

GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query=47.632346,-122.138874&interval=15

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

{
  "summary": {
    "briefPhrase60": "Rain ending in 25 min",
    "shortPhrase": "Rain ending in 25 min",
    "briefPhrase": "Rain ending in 25 min",
    "longPhrase": "Rain ending in 25 min",
    "iconCode": 12
  },
  "intervalSummaries": [
    {
      "startMinute": 0,
      "endMinute": 24,
      "totalMinutes": 25,
      "shortPhrase": "Rain ending in %minute_value min",
      "briefPhrase": "Rain ending in %minute_value min",
      "longPhrase": "Rain ending in %minute_value min",
      "iconCode": 12
    },
    {
      "startMinute": 25,
      "endMinute": 119,
      "totalMinutes": 95,
      "shortPhrase": "No precip for %MINUTE_VALUE min",
      "briefPhrase": "No precipitation for at least %MINUTE_VALUE min",
      "longPhrase": "No precipitation for at least %MINUTE_VALUE min",
      "iconCode": 7
    }
  ],
  "intervals": [
    {
      "startTime": "2019-11-14T15:18:00-08:00",
      "minute": 0,
      "dbz": 23,
      "shortPhrase": "Light Rain",
      "threshold": "LIGHT",
      "color": {
        "red": 8,
        "green": 98,
        "blue": 2,
        "hex": "#086202"
      },
      "simplifiedColor": {
        "red": 35,
        "green": 190,
        "blue": 39,
        "hex": "#23BE27"
      },
      "precipitationType": "Rain",
      "iconCode": 12,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T15:33:00-08:00",
      "minute": 15,
      "dbz": 18,
      "shortPhrase": "Light Rain",
      "threshold": "LIGHT",
      "color": {
        "red": 32,
        "green": 133,
        "blue": 9,
        "hex": "#208509"
      },
      "simplifiedColor": {
        "red": 35,
        "green": 190,
        "blue": 39,
        "hex": "#23BE27"
      },
      "precipitationType": "Rain",
      "iconCode": 12,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T15:48:00-08:00",
      "minute": 30,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:03:00-08:00",
      "minute": 45,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:18:00-08:00",
      "minute": 60,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:33:00-08:00",
      "minute": 75,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:48:00-08:00",
      "minute": 90,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T17:03:00-08:00",
      "minute": 105,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    }
  ]
}

Определения

Имя Описание
ColorValue
ErrorAdditionalInfo

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

ErrorDetail

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

ErrorResponse

Ответ на ошибку

ForecastInterval
IconCode

Числовое значение, представляющее изображение, отображающее .iconPhrase Дополнительные сведения см. в статье Службы погоды в Azure Maps .

IntervalSummary
JsonFormat

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

MinuteForecastResult
MinuteForecastSummary

Резюме фраз за весь прогнозируемый период.

PrecipitationType

Указывает тип осадков («Дождь», «Снег», «Лед» или «Смесь»). Если dbz равен нулю, precipitationType отсутствует в ответе.

ColorValue

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

integer (int32)

Синяя составляющая значения RGB

green

integer (int32)

Зеленый компонент значения RGB.

hex

string

Шестнадцатеричное значение цвета.

red

integer (int32)

Красная составляющая значения RGB.

ErrorAdditionalInfo

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

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

object

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

type

string

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

ErrorDetail

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

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

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

ErrorDetail[]

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

message

string

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

target

string

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

ErrorResponse

Ответ на ошибку

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

ErrorDetail

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

ForecastInterval

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

integer (int32)

Процент представляет облачность.

color

ColorValue

Цвет полного спектра, который соответствует дБЗ (децибел относительно Z). Если dbz равен нулю, цвет в ответе отсутствует.

dbz

number (double)

Единица измерения, представляющая прогнозируемую интенсивность осадков.

iconCode

IconCode (int32)

Числовое значение, представляющее изображение, отображающее .iconPhrase Дополнительные сведения см. в статье Службы погоды в Azure Maps .

minute

integer (int32)

Первая минута для антракта.

precipitationType

PrecipitationType

Указывает тип осадков («Дождь», «Снег», «Лед» или «Смесь»). Если dbz равен нулю, precipitationType отсутствует в ответе.

shortPhrase

string

Короткая фраза, описывающая условия осадков на интервале.

simplifiedColor

ColorValue

Цвет канала, который соответствует типу и порогу осадков. Если dbz равен нулю, то в ответе не присутствует.

startTime

string (date-time)

Дата и время начала интервала в формате ISO 8601, например, 2019-10-27T19:39:57-08:00.

threshold

string

Ключ, указывающий пороговое значение. Наряду с precipitationType, может использоваться для определения simplifiedColor. Если dbz равен нулю, то в ответе не присутствует.

IconCode

Числовое значение, представляющее изображение, отображающее .iconPhrase Дополнительные сведения см. в статье Службы погоды в Azure Maps .

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

Солнечно

10
11

Туман

12

Ливень

13

Значительная облачность, ливни

14

Небольшая облачность, ливни

15

Гроза

16

Значительная облачность, грозы

17

Небольшая облачность, грозы

18

дождь.

19

Снегопад

2

Малооблачно

20

Значительная облачность, небольшой снег

21

Переменная облачность с небольшими снегопадами

22

Снег

23

Значительная облачность, снег

24

Лёд

25

Дождь со снегом

26

Замерзающий дождь

27
28
29

Дождь со снегом

3

Небольшая облачность

30

жарко

31

холод

32

Ветрено

33

Очистить

34

Малооблачно

35

Частичная облачность

36

Кратковременная облачность (ночь)

37

Туманное Лунное Свечение

38

Преимущественно облачно (ночь)

39

Частичная облачность, ливни

4

Переменная облачность

40

Преимущественно облачно с ливнями (ночь)

41

Частичная облачность, грозы

42

Преимущественно облачно с грозами (ночь)

43

Преимущественно облачно со шквалами (ночь)

44

Преимущественно облачно со снегом (ночь)

5

Солнечно с дымкой

6

Преимущественно облачно

7

Облачно

8

Пасмурно (сплошная облачность)

9

IntervalSummary

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

string

Краткая резюмирующая фраза. Длина фразы составляет примерно 60 символов.

endMinute

integer (int32)

Последняя минута, к которой относится сводка.

iconCode

IconCode (int32)

Числовое значение, представляющее изображение, отображающее .iconPhrase Дополнительные сведения см. в статье Службы погоды в Azure Maps .

longPhrase

string

Длинная обобщающая фраза. Длина фразы — 60+ символов.

shortPhrase

string

Краткая обобщающая фраза. Длина фразы составляет примерно 25 символов.

startMinute

integer (int32)

Первая минута, к которой относится сводка.

totalMinutes

integer (int32)

Количество минут, в течение которых применяется сводка.

JsonFormat

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

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

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

MinuteForecastResult

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

IntervalSummary[]

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

intervals

ForecastInterval[]

Данные прогноза для каждого интервала в прогнозе.

summary

MinuteForecastSummary

Резюме фраз за весь прогнозируемый период.

MinuteForecastSummary

Резюме фраз за весь прогнозируемый период.

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

string

Итоговая фраза на следующие 120 минут. Длина фразы составляет примерно 60 символов.

briefPhrase60

string

Итоговая фраза на ближайшие 60 минут. Длина фразы составляет примерно 60 символов.

iconCode

IconCode (int32)

Числовое значение, представляющее изображение, отображающее .iconPhrase Дополнительные сведения см. в статье Службы погоды в Azure Maps .

longPhrase

string

Длинная суммарная фраза на следующие 120 минут. Длина фразы — 60+ символов.

shortPhrase

string

Короткая обобщающая фраза на ближайшие 120 минут. Длина фразы составляет примерно 25 символов.

PrecipitationType

Указывает тип осадков («Дождь», «Снег», «Лед» или «Смесь»). Если dbz равен нулю, precipitationType отсутствует в ответе.

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

Лёд

Mix

Смешивать

Rain

дождь.

Snow

Снег