Weather - Get Minute Forecast
Используйте для получения поминутного прогноза на следующие 120 минут с интервалами 1, 5 и 15 минут.
Get Minute Forecast
API — это HTTP-запросGET
, который возвращает поминутные прогнозы для заданного расположения на следующие 120 минут. Пользователи могут запрашивать прогноз погоды с интервалом 1, 5 и 15 минут. Ответ будет включать такие сведения, как тип осадков (включая дождь, снег или смесь обоих), время начала и значение интенсивности осадков (dBZ). Дополнительные сведения см. в разделе Запрос поминутных данных прогноза погоды.
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 |
Требуемый формат ответа. Поддерживается только формат |
|
api-version
|
query | True |
string |
Номер версии API Azure Maps |
query
|
query | True |
number[] |
Применимый запрос, указанный в виде строки, разделенной запятыми, состоящей из широты и долготы, например "47,641268,-122.125679". |
interval
|
query |
integer |
Задает интервал времени в минутах для возвращаемого прогноза погоды. Поддерживаемые значения:
|
|
language
|
query |
string |
Язык, на котором должны возвращаться результаты поиска. Должен быть одним из поддерживаемых языковых тегов IETF без учета регистра. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию. Дополнительные сведения см. в разделе Поддерживаемые языки . |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
x-ms-client-id |
string |
Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Идентификатора Microsoft Entra. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи плоскости управления Azure Maps. Инструкции по использованию безопасности Microsoft Entra ID в Azure Maps см. в следующих статьях . |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
ОК |
|
Other Status Codes |
Произошла непредвиденная ошибка. |
Безопасность
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 можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.
Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи сопоставления , чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер 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
}
]
}
Определения
Имя | Описание |
---|---|
Color |
|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Сообщение об ошибке |
Forecast |
|
Icon |
Числовое значение, представляющее изображение, отображающее |
Interval |
|
Json |
Требуемый формат ответа. Поддерживается только формат |
Minute |
|
Minute |
Сводка фраз за весь прогнозный период. |
Precipitation |
Указывает тип осадков ("Дождь", "Снег", "Лед" или "Смесь"). Если dbz равно нулю, в ответе отсутствует тип осадков. |
ColorValue
Имя | Тип | Описание |
---|---|---|
blue |
integer |
Синий компонент RGB-значения |
green |
integer |
Зеленый компонент rgb-значения. |
hex |
string |
Шестнадцатеричное значение цвета. |
red |
integer |
Красный компонент rgb-значения. |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Тип дополнительных сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Сообщение об ошибке
Имя | Тип | Описание |
---|---|---|
error |
Объект error. |
ForecastInterval
Имя | Тип | Описание |
---|---|---|
cloudCover |
integer |
Процент, представляющий облачное покрытие. |
color |
Цвет полного спектра, который сопоставляется с dBZ (децибел относительно Z). Если dbz равно нулю, цвет отсутствует в ответе. |
|
dbz |
number |
Единица измерения, представляющая прогнозируемую интенсивность осадков. |
iconCode |
Числовое значение, представляющее изображение, отображающее |
|
minute |
integer |
Первая минута интервала. |
precipitationType |
Указывает тип осадков ("Дождь", "Снег", "Лед" или "Смесь"). Если dbz равно нулю, в ответе отсутствует тип осадков. |
|
shortPhrase |
string |
Короткая фраза, описывающая условия осадков для интервала. |
simplifiedColor |
Цвет полосы, который сопоставляется с типом осадков и пороговым значением. Если dbz равно нулю, в ответе отсутствует. |
|
startTime |
string |
Дата и время начала интервала в формате ISO 8601, например 2019-10-27T19:39:57-08:00. |
threshold |
string |
Ключ, указывающий пороговое значение. Наряду с типом осадков, можно использовать для определения элемента simplifiedColor. Если dbz равно нулю, в ответе отсутствует. |
IconCode
Числовое значение, представляющее изображение, отображающее iconPhrase
. Дополнительные сведения см. в статье Службы погоды в Azure Maps .
Имя | Тип | Описание |
---|---|---|
1 |
Integer |
|
10 |
Integer |
|
11 |
Integer |
|
12 |
Integer |
|
13 |
Integer |
|
14 |
Integer |
|
15 |
Integer |
|
16 |
Integer |
|
17 |
Integer |
|
18 |
Integer |
|
19 |
Integer |
|
2 |
Integer |
|
20 |
Integer |
|
21 |
Integer |
|
22 |
Integer |
|
23 |
Integer |
|
24 |
Integer |
|
25 |
Integer |
|
26 |
Integer |
|
27 |
Integer |
|
28 |
Integer |
|
29 |
Integer |
|
3 |
Integer |
|
30 |
Integer |
|
31 |
Integer |
|
32 |
Integer |
|
33 |
Integer |
|
34 |
Integer |
|
35 |
Integer |
|
36 |
Integer |
|
37 |
Integer |
|
38 |
Integer |
|
39 |
Integer |
|
4 |
Integer |
|
40 |
Integer |
|
41 |
Integer |
|
42 |
Integer |
|
43 |
Integer |
|
44 |
Integer |
|
5 |
Integer |
|
6 |
Integer |
|
7 |
Integer |
|
8 |
Integer |
|
9 |
Integer |
IntervalSummary
Имя | Тип | Описание |
---|---|---|
briefPhrase |
string |
Краткая суммарная фраза. Длина фразы составляет около 60 символов. |
endMinute |
integer |
Последняя минута, к которой применяется сводка. |
iconCode |
Числовое значение, представляющее изображение, отображающее |
|
longPhrase |
string |
Длинная суммарная фраза. Длина фразы составляет более 60 символов. |
shortPhrase |
string |
Краткая суммарная фраза. Длина фразы составляет около 25 символов. |
startMinute |
integer |
Первая минута, к которой применяется сводка. |
totalMinutes |
integer |
Количество минут, в течение которых применяется сводка. |
JsonFormat
Требуемый формат ответа. Поддерживается только формат json
.
Имя | Тип | Описание |
---|---|---|
json |
string |
MinuteForecastResult
Имя | Тип | Описание |
---|---|---|
intervalSummaries |
Сводная информация для каждого интервала в прогнозе. Сводка разбивает каждый потенциальный интервал, где начинается и останавливается осадки. |
|
intervals |
Данные прогноза для каждого интервала в прогнозе. |
|
summary |
Сводка фраз за весь прогнозный период. |
MinuteForecastSummary
Сводка фраз за весь прогнозный период.
Имя | Тип | Описание |
---|---|---|
briefPhrase |
string |
Суммарная фраза на следующие 120 минут. Длина фразы составляет около 60 символов. |
briefPhrase60 |
string |
Суммарная фраза на следующие 60 минут. Длина фразы составляет около 60 символов. |
iconCode |
Числовое значение, представляющее изображение, отображающее |
|
longPhrase |
string |
Длинная суммарная фраза на следующие 120 минут. Длина фразы составляет более 60 символов. |
shortPhrase |
string |
Краткая суммарная фраза на следующие 120 минут. Длина фразы составляет около 25 символов. |
PrecipitationType
Указывает тип осадков ("Дождь", "Снег", "Лед" или "Смесь"). Если dbz равно нулю, в ответе отсутствует тип осадков.
Имя | Тип | Описание |
---|---|---|
Ice |
string |
Айс (Ice) |
Mix |
string |
Набор |
Rain |
string |
Дождь |
Snow |
string |
Снег |