Weather - Get Weather Along Route
Используйте его для получения точного up-toмгновенного прогноза с точки зрения местоположения, который включает оценку опасных погодных явлений и уведомления по маршруту.
Get Weather Along Route
API представляет собой HTTP-запросGET
up-to, который возвращает гиперлокальные (один километр или меньше), прогнозы погоды с точностью до минуты, оценки погодных опасностей и уведомления вдоль маршрута, описанного как последовательность путевых точек.
Он включает в себя список погодных опасностей, влияющих на путевую точку или маршрут, а агрегированный индекс опасности для каждой путевой точки может быть использован для окрашивания каждой части маршрута в соответствии с тем, насколько она безопасна для водителя. При отправке путевых точек рекомендуется оставаться в пределах или близко к расстоянию, которое можно преодолеть в течение 120 минут или вскоре после этого. Данные обновляются каждые пять минут.
Эта служба дополняет службу маршрутов Azure Maps , которая позволяет сначала запрашивать маршрут между источником и пунктом назначения и использовать его в качестве входных данных для конечной точки Weather Along Route.
Кроме того, сервис поддерживает сценарии создания уведомлений о погоде для путевых точек, интенсивность которых увеличивается. Например, если ожидается, что на транспортном средстве начнется сильный дождь, когда он достигнет путевой точки, для этой путевой точки будет сгенерировано уведомление о сильном дожде, что позволит конечному продукту отобразить уведомление о сильном дожде до того, как водитель достигнет этой путевой точки. Триггер отображения уведомления для путевой точки может быть основан, например, на геозоне или выбираемом расстоянии до путевой точки.
API охватывает все регионы планеты, кроме широт над Гренландией и Антарктидой.
GET https://atlas.microsoft.com/weather/route/json?api-version=1.1&query={query}
GET https://atlas.microsoft.com/weather/route/json?api-version=1.1&query={query}&language={language}
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
format
|
path | True |
Требуемый формат ответа. Поддерживается только |
|
api-version
|
query | True |
string |
Номер версии API Azure Maps. |
query
|
query | True |
string |
Координаты, по которым рассчитывается маршрут, разделенные двоеточием (:) и введенные в хронологическом порядке. Требуется как минимум две путевые точки. Один вызов API может содержать до 60 путевых точек. Путевая точка указывает местоположение, расчетное время прибытия и необязательное направление: широта, долгота, время прибытия, направление, где
Рекомендуется оставаться в пределах или близко к расстоянию, которое можно преодолеть в течение 120 минут или вскоре после этого. Таким образом, можно обеспечить более точную оценку поездки и предотвратить захват отдельных событий между путевыми точками. Информация может и должна обновляться по маршруту (особенно для поездок продолжительностью более 2 часов), чтобы постоянно вытягивать новые путевые точки в будущем, а также для обеспечения точности прогнозной информации о содержании, таком как тип и интенсивность осадков, по мере развития и рассеивания штормов с течением времени. |
language
|
query |
string |
Язык, в котором должны быть возвращены результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF, не учитывает регистр. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию. Дополнительные сведения см. в поддерживаемых языках. |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
x-ms-client-id |
string |
Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности идентификатора Microsoft Entra. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Сведения о том, как использовать безопасность идентификатора Microsoft Entra в 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, пакетов 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 detailed weather casts along a route described as a sequence of waypoints
Образец запроса
GET https://atlas.microsoft.com/weather/route/json?api-version=1.1&query=38.907,-77.037,0:38.907,-77.009,10:38.926,-76.928,20:39.033,-76.852,30:39.168,-76.732,40:39.269,-76.634,50:39.287,-76.612,60
Пример ответа
{
"summary": {
"iconCode": 35,
"hazards": {
"maxHazardIndex": 0
}
},
"waypoints": [
{
"iconCode": 38,
"shortPhrase": "Mostly cloudy",
"isDayTime": false,
"cloudCover": 70,
"temperature": {
"value": 3.4,
"unit": "C",
"unitType": 17
},
"wind": {
"direction": {
"degrees": 142
},
"speed": {
"value": 2,
"unit": "km/h",
"unitType": 7
}
},
"windGust": {
"speed": {
"value": 3,
"unit": "km/h",
"unitType": 7
}
},
"precipitation": {
"dbz": 0,
"type": "SNOW"
},
"lightningCount": 0,
"sunGlare": {
"calculatedVehicleHeading": 90,
"glareIndex": 0
},
"hazards": {
"maxHazardIndex": 0
},
"notifications": []
},
{
"iconCode": 38,
"shortPhrase": "Mostly cloudy",
"isDayTime": false,
"cloudCover": 65,
"temperature": {
"value": 3.4,
"unit": "C",
"unitType": 17
},
"wind": {
"direction": {
"degrees": 166
},
"speed": {
"value": 1,
"unit": "km/h",
"unitType": 7
}
},
"windGust": {
"speed": {
"value": 2,
"unit": "km/h",
"unitType": 7
}
},
"precipitation": {
"dbz": 0,
"type": "SNOW"
},
"lightningCount": 0,
"sunGlare": {
"calculatedVehicleHeading": 77,
"glareIndex": 0
},
"hazards": {
"maxHazardIndex": 0
},
"notifications": []
},
{
"iconCode": 35,
"shortPhrase": "Partly cloudy",
"isDayTime": false,
"cloudCover": 43,
"temperature": {
"value": 3.2,
"unit": "C",
"unitType": 17
},
"wind": {
"direction": {
"degrees": 163
},
"speed": {
"value": 2,
"unit": "km/h",
"unitType": 7
}
},
"windGust": {
"speed": {
"value": 2,
"unit": "km/h",
"unitType": 7
}
},
"precipitation": {
"dbz": 0,
"type": "SNOW"
},
"lightningCount": 0,
"sunGlare": {
"calculatedVehicleHeading": 44,
"glareIndex": 0
},
"hazards": {
"maxHazardIndex": 0
},
"notifications": []
},
{
"iconCode": 35,
"shortPhrase": "Partly cloudy",
"isDayTime": false,
"cloudCover": 34,
"temperature": {
"value": 1.6,
"unit": "C",
"unitType": 17
},
"wind": {
"direction": {
"degrees": 189
},
"speed": {
"value": 2,
"unit": "km/h",
"unitType": 7
}
},
"windGust": {
"speed": {
"value": 4,
"unit": "km/h",
"unitType": 7
}
},
"precipitation": {
"dbz": 0,
"type": "SNOW"
},
"lightningCount": 0,
"sunGlare": {
"calculatedVehicleHeading": 32,
"glareIndex": 0
},
"hazards": {
"maxHazardIndex": 0
},
"notifications": []
},
{
"iconCode": 38,
"shortPhrase": "Mostly cloudy",
"isDayTime": false,
"cloudCover": 54,
"temperature": {
"value": 0.5,
"unit": "C",
"unitType": 17
},
"wind": {
"direction": {
"degrees": 202
},
"speed": {
"value": 4,
"unit": "km/h",
"unitType": 7
}
},
"windGust": {
"speed": {
"value": 5,
"unit": "km/h",
"unitType": 7
}
},
"precipitation": {
"dbz": 0,
"type": "SNOW"
},
"lightningCount": 0,
"sunGlare": {
"calculatedVehicleHeading": 36,
"glareIndex": 0
},
"hazards": {
"maxHazardIndex": 0
},
"notifications": []
},
{
"iconCode": 35,
"shortPhrase": "Partly cloudy",
"isDayTime": false,
"cloudCover": 46,
"temperature": {
"value": 2.4,
"unit": "C",
"unitType": 17
},
"wind": {
"direction": {
"degrees": 222
},
"speed": {
"value": 4,
"unit": "km/h",
"unitType": 7
}
},
"windGust": {
"speed": {
"value": 5,
"unit": "km/h",
"unitType": 7
}
},
"precipitation": {
"dbz": 0,
"type": "SNOW"
},
"lightningCount": 0,
"sunGlare": {
"calculatedVehicleHeading": 38,
"glareIndex": 0
},
"hazards": {
"maxHazardIndex": 0
},
"notifications": []
},
{
"iconCode": 35,
"shortPhrase": "Partly cloudy",
"isDayTime": false,
"cloudCover": 39,
"temperature": {
"value": 2.3,
"unit": "C",
"unitType": 17
},
"wind": {
"direction": {
"degrees": 231
},
"speed": {
"value": 4,
"unit": "km/h",
"unitType": 7
}
},
"windGust": {
"speed": {
"value": 5,
"unit": "km/h",
"unitType": 7
}
},
"precipitation": {
"dbz": 0,
"type": "SNOW"
},
"lightningCount": 0,
"sunGlare": {
"calculatedVehicleHeading": 43,
"glareIndex": 0
},
"hazards": {
"maxHazardIndex": 0
},
"notifications": []
}
]
}
Определения
Имя | Описание |
---|---|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Ответ на ошибку |
Hazard |
|
Hazard |
Индекс серьезности/опасности.
|
Icon |
Числовое значение, представляющее изображение, отображающее . |
Json |
Требуемый формат ответа. Поддерживается только |
Sun |
Рейтинг, который показывает, насколько солнце ослепляет водителя. |
Unit |
Числовое значение ID, связанное с типом отображаемой единицы измерения. Может использоваться для перевода единиц измерения. Дополнительные сведения см. в статье Службы погоды в Azure Maps . |
Weather |
Прогноз осадков погоды вдоль маршрута. |
Weather |
Этот объект возвращается из успешного результата Weather Along Route. |
Weather |
Краткая сводка о погоде на маршруте. |
Weather |
Описание опасности погодных условий, влияющих на поездку. |
Weather |
|
Weather |
Удельное значение данной единицы, связанное с погодой. |
Weather |
|
Wind |
Возвращаются данные о ветре, включая скорость и направление. |
Wind |
Направление ветра |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Ответ на ошибку
Имя | Тип | Описание |
---|---|---|
error |
Объект ошибки. |
HazardDetail
Имя | Тип | Описание |
---|---|---|
hazardCode |
string |
Уникальный идентификатор (неотображаемый) для каждого типа опасности: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning. |
hazardIndex |
Hazard |
Индекс серьезности/опасности.
|
shortPhrase |
string |
Отображаемая короткая фраза, описывающая прогнозируемые условия и интенсивность/тип осадков. |
HazardIndex
Индекс серьезности/опасности.
-
0
- Отсутствие опасности. -
1
- Будьте в курсе, будьте в курсе. -
2
- Будьте внимательны, будьте готовы. -
3
- Примите меры. -
4
- Угрожающие жизни, чрезвычайные.
Значение | Описание |
---|---|
0 |
Отсутствие опасности |
1 |
Будьте в курсе |
2 |
Обращать внимание |
3 |
Действия |
4 |
Аварийная ситуация |
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 |
JsonFormat
Требуемый формат ответа. Поддерживается только json
формат.
Значение | Описание |
---|---|
json |
SunGlare
Рейтинг, который показывает, насколько солнце ослепляет водителя.
Имя | Тип | Описание |
---|---|---|
calculatedVehicleHeading |
integer (int32) |
Если значение направления движения транспортного средства не указано для путевой точки, то сервис рассчитает направление на основе местоположения соседних путевых точек, если они указаны. |
glareIndex |
integer (int32) |
Индекс от 0 до 100, указывающий на интенсивность солнечных бликов для водителя. Значение 50 и выше может считаться опасным для некоторых водителей, а значение 100 означает, что водитель едет прямо на солнце, а атмосферные условия ясны, что позволяет полной интенсивности солнца ослеплять водителя. |
UnitType
Числовое значение ID, связанное с типом отображаемой единицы измерения. Может использоваться для перевода единиц измерения. Дополнительные сведения см. в статье Службы погоды в Azure Maps .
Значение | Описание |
---|---|
0 |
футы |
1 |
дюймы |
10 |
метры в секунду (м/с) |
11 |
гектопаскали |
12 |
дюймы ртутного столба |
13 |
килопаскали |
14 |
миллибары |
15 |
миллиметры ртутного столба (мм рт. столба) |
16 |
poundsPerSquareInch (фунт/кв. дюйм) |
17 |
Цельсия |
18 |
Фаренгейт |
19 |
Кельвин |
2 |
мили |
20 |
процент |
21 |
плавать |
22 |
целое число |
3 |
миллиметр |
31 |
МикрограммКубический метр воздуха |
4 |
сантиметр |
5 |
метр |
6 |
километр |
7 |
километры в час (км/час) |
8 |
узлы |
9 |
миль в час |
WeatherAlongRoutePrecipitation
Прогноз осадков погоды вдоль маршрута.
Имя | Тип | Описание |
---|---|---|
dbz |
number (double) |
Прогнозируемая интенсивность осадков в дБЗ (децибелы относительно Z) от 0,0 до 100,0. |
type |
string |
Тип осадков. Если осадки выпадут, то тип которых они будут: «ДОЖДЬ», «ГРАД», «СНЕГ», «ЛЕД» или «СМЕСЬ». |
WeatherAlongRouteResult
Этот объект возвращается из успешного результата Weather Along Route.
Имя | Тип | Описание |
---|---|---|
summary |
Краткая сводка о погоде на маршруте. |
|
waypoints |
Данные для каждой путевой точки возвращаются в том же порядке, который указан в запросе. |
WeatherAlongRouteSummary
Краткая сводка о погоде на маршруте.
Имя | Тип | Описание |
---|---|---|
hazards |
Описание опасности погодных условий, влияющих на поездку. |
|
iconCode |
Icon |
Числовое значение, представляющее изображение, отображающее . |
WeatherHazards
Описание опасности погодных условий, влияющих на поездку.
Имя | Тип | Описание |
---|---|---|
hazardDetails |
Подробная информация об опасных погодных условиях, влияющих на поездку. |
|
maxHazardIndex |
Hazard |
Индекс серьезности/опасности.
|
WeatherNotification
Имя | Тип | Описание |
---|---|---|
hazardCode |
string |
Уникальный идентификатор (неотображаемый) для каждого типа опасности: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning. |
hazardIndex |
Hazard |
Индекс серьезности/опасности.
|
shortPhrase |
string |
Отображаемая короткая фраза, описывающая прогнозируемые условия и интенсивность/тип осадков. |
type |
string |
Тип уведомления, создаваемого для предупреждения водителей о наступлении опасности или увеличении ее интенсивности. |
WeatherUnit
Удельное значение данной единицы, связанное с погодой.
Имя | Тип | Описание |
---|---|---|
unit |
string |
Тип единицы измерения для возвращаемого значения. |
unitType |
Unit |
Числовое значение ID, связанное с типом отображаемой единицы измерения. Может использоваться для перевода единиц измерения. Дополнительные сведения см. в статье Службы погоды в Azure Maps . |
value |
number (float) |
Округленное значение. |
WeatherWaypoint
Имя | Тип | Описание |
---|---|---|
cloudCover |
integer (int32) |
Процент представляет облачность. |
hazards |
Описание опасности погодных условий, влияющих на поездку. |
|
iconCode |
Icon |
Числовое значение, представляющее изображение, отображающее . |
isDayTime |
boolean |
Указывает время суток. True обозначает 'день',' false указывает на 'ночь. |
lightningCount |
integer (int32) |
Оценка интенсивности грозы в открытом масштабе. Значение 0 означает, что грозы нет; Значения 1 и выше означают грозу с нарастающей интенсивностью. |
notifications |
Список уведомлений об опасных погодных условиях. |
|
precipitation |
Прогноз осадков погоды вдоль маршрута. |
|
shortPhrase |
string |
Отображаемая короткая фраза, описывающая прогнозируемые условия и интенсивность/тип осадков. |
sunGlare |
Рейтинг, который показывает, насколько солнце ослепляет водителя. |
|
temperature |
Удельное значение данной единицы, связанное с погодой. |
|
wind |
Возвращаются данные о ветре, включая скорость и направление. |
|
windGust |
Возвращаются данные о ветре, включая скорость и направление. |
WindDetails
Возвращаются данные о ветре, включая скорость и направление.
Имя | Тип | Описание |
---|---|---|
direction |
Направление ветра |
|
speed |
Скорость ветра в указанной единице. |
WindDirection
Направление ветра
Имя | Тип | Описание |
---|---|---|
degrees |
integer (int32) |
Направление ветра в градусах по азимуту, начиная с истинного севера и продолжая по часовой стрелке. Север составляет 0 градусов, восток составляет 90 градусов, юг составляет 180 градусов, запад — 270 градусов. Возможные значения 0-359. |
localizedDescription |
string |
Аббревиатура направления на указанном языке. |