Weather - Get Weather Along Route

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

Get Weather Along Route API — это HTTP-запросGET, который возвращает гипер-локальный (один километр или меньше), поминутные сообщения о погоде, оценки погодных рисков и уведомления по маршруту, описываемом как последовательность точек маршрута. Сюда входит список погодных опасностей, влияющих на точку пути или маршрут, и агрегированный индекс опасности для каждой точки маршрута может использоваться для закрашивки каждого участка маршрута в соответствии с тем, насколько он безопасен для водителя. При отправке точек маршрута рекомендуется оставаться в пределах или близком расстоянии, которое может быть пройдено в течение 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

JsonFormat

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

api-version
query True

string

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

query
query True

string

Координаты, по которым вычисляется маршрут, разделенные двоеточием (:) и введенные в хронологическом порядке. Требуется не менее двух точек. Один вызов API может содержать до 60 точек. Путьная точка указывает расположение, ETA и необязательный заголовок: широта, долгота, ETA, заголовок, где

  • Latitude — координата широты в десятичных градусах.
  • Longitude — координата долготы в десятичных градусах.
  • ETA (estimated time of arrival) - Количество минут от текущего времени, которое потребуется для того, чтобы транспортное средство достигло точки пути. Допустимый диапазон — от 0,0 до 120,0 минут.
  • Heading — необязательное значение, указывающее заголовок транспортного средства при прохождении точки пути. Выражается в градусах по часовой стрелке относительно истинного севера. Это выдается для вычисления солнечных бликов как опасности вождения. Допустимый диапазон — от 0,0 до 360,0 градусов. Если этот параметр не указан, заголовок будет автоматически производен на основе позиции соседних точек.

Рекомендуется оставаться в пределах или близком расстоянии, которое может быть пройдено в течение 120 минут или вскоре после него. Таким образом, можно обеспечить более точную оценку поездки и предотвратить отсутствие отслеживания изолированных событий между точками маршрута. Информация может и должна обновляться по маршруту (особенно для поездок более 2 часов), чтобы постоянно тянуть новые точки пути движущихся вперед, но и для обеспечения точности прогнозной информации для такого содержания, как тип осадков и интенсивность, является точной по мере развития и рассеяния штормов с течением времени.

language
query

string

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

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

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

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

string

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

Ответы

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

WeatherAlongRouteResult

ОК

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

Это общий ключ, который подготавливается при создании учетной записи Azure Maps в портал Azure или с помощью PowerShell, CLI, пакетов AZURE SDK или 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 можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

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

Type: apiKey
In: header

Примеры

Successfully retrieve detailed weather casts along a route described as a sequence of waypoints

Sample Request

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

Sample Response

{
  "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": []
    }
  ]
}

Определения

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

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

ErrorDetail

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

ErrorResponse

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

HazardDetail
HazardIndex

Индекс серьезности или опасности.

  • 0 - Никакой опасности.
  • 1 - Будьте информированы, будьте в курсе.
  • 2 - Обратите внимание, будьте готовы.
  • 3 — Принять меры.
  • 4 - Опасные для жизни, чрезвычайные ситуации.
IconCode

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

JsonFormat

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

SunGlare

Оценка, показывающая, насколько ослепит солнце для водителя.

UnitType

Числовое значение идентификатора, связанное с типом отображаемой единицы измерения. Может использоваться для преобразования единиц. Дополнительные сведения см. в разделе Службы погоды в Azure Maps.

WeatherAlongRoutePrecipitation

Прогноз осадков погоды на маршруте.

WeatherAlongRouteResult

Этот объект возвращается из успешного маршрута Weather Along.

WeatherAlongRouteSummary

Краткая сводка о погоде на маршруте.

WeatherHazards

Описание погодных рисков, влияющих на поездку.

WeatherNotification
WeatherUnit

Конкретное значение заданной единицы измерения, связанное с погодой.

WeatherWaypoint
WindDetails

Возвращаемые сведения о ветре, включая скорость и направление.

WindDirection

Направление ветра

ErrorAdditionalInfo

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

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

object

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

type

string

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

ErrorDetail

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

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

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

ErrorDetail[]

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

message

string

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

target

string

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

ErrorResponse

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

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

ErrorDetail

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

HazardDetail

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

string

Уникальный идентификатор (не отображаемый) для каждого типа опасности: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindHigh, WindХайл, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning.

hazardIndex

HazardIndex

Индекс серьезности или опасности.

  • 0 - Никакой опасности.
  • 1 - Будьте информированы, будьте в курсе.
  • 2 - Обратите внимание, будьте готовы.
  • 3 — Принять меры.
  • 4 - Опасные для жизни, чрезвычайные ситуации.
shortPhrase

string

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

HazardIndex

Индекс серьезности или опасности.

  • 0 - Никакой опасности.
  • 1 - Будьте информированы, будьте в курсе.
  • 2 - Обратите внимание, будьте готовы.
  • 3 — Принять меры.
  • 4 - Опасные для жизни, чрезвычайные ситуации.
Имя Тип Описание
0

Integer

1

Integer

2

Integer

3

Integer

4

Integer

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

JsonFormat

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

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

string

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

SunGlare

Оценка, показывающая, насколько ослепит солнце для водителя.

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

integer

Если значение заголовка транспортного средства не указано для точки пути, служба вычислит заголовок на основе расположения соседних путевых точек, если это указано.

glareIndex

integer

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

UnitType

Числовое значение идентификатора, связанное с типом отображаемой единицы измерения. Может использоваться для преобразования единиц. Дополнительные сведения см. в разделе Службы погоды в Azure Maps.

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

Integer

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

3

Integer

31

Integer

4

Integer

5

Integer

6

Integer

7

Integer

8

Integer

9

Integer

WeatherAlongRoutePrecipitation

Прогноз осадков погоды на маршруте.

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

number

Прогнозируемая интенсивность осадков в дБЗ (децибелы относительно Z) от 0,0 до 100,0.

type

string

Тип осадков. Если выпадает количество осадков, это будет тип: "RAIN", "HAIL", "SNOW", "ICE" или "MIX".

WeatherAlongRouteResult

Этот объект возвращается из успешного маршрута Weather Along.

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

WeatherAlongRouteSummary

Краткая сводка о погоде на маршруте.

waypoints

WeatherWaypoint[]

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

WeatherAlongRouteSummary

Краткая сводка о погоде на маршруте.

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

WeatherHazards

Описание погодных рисков, влияющих на поездку.

iconCode

IconCode

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

WeatherHazards

Описание погодных рисков, влияющих на поездку.

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

HazardDetail[]

Сведения о погодных опасностях, влияющих на поездку.

maxHazardIndex

HazardIndex

Индекс серьезности или опасности.

  • 0 - Никакой опасности.
  • 1 - Будьте информированы, будьте в курсе.
  • 2 - Обратите внимание, будьте готовы.
  • 3 — Принять меры.
  • 4 - Опасные для жизни, чрезвычайные ситуации.

WeatherNotification

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

string

Уникальный идентификатор (не отображаемый) для каждого типа опасности: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindHigh, WindХайл, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning.

hazardIndex

HazardIndex

Индекс серьезности или опасности.

  • 0 - Никакой опасности.
  • 1 - Будьте информированы, будьте в курсе.
  • 2 - Обратите внимание, будьте готовы.
  • 3 — Принять меры.
  • 4 - Опасные для жизни, чрезвычайные ситуации.
shortPhrase

string

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

type

string

Тип уведомления, создаваемого для предупреждения водителей о наступлении опасности или увеличении интенсивности опасности.

WeatherUnit

Конкретное значение заданной единицы измерения, связанное с погодой.

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

string

Тип единицы измерения для возвращаемого значения.

unitType

UnitType

Числовое значение идентификатора, связанное с типом отображаемой единицы измерения. Может использоваться для преобразования единиц. Дополнительные сведения см. в разделе Службы погоды в Azure Maps.

value

number

Округленное значение.

WeatherWaypoint

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

integer

Процент, представляющий облачное покрытие.

hazards

WeatherHazards

Описание погодных рисков, влияющих на поездку.

iconCode

IconCode

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

isDayTime

boolean

Указывает время суток. Значение True указывает на "день", "значение false" — "ночь".

lightningCount

integer

Оценка интенсивности грозы в открытом масштабе. Значение 0 означает отсутствие грозы; Значения 1 и выше означают, что гроза растет интенсивностью.

notifications

WeatherNotification[]

Список уведомлений об опасности погоды.

precipitation

WeatherAlongRoutePrecipitation

Прогноз осадков погоды на маршруте.

shortPhrase

string

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

sunGlare

SunGlare

Оценка, показывающая, насколько ослепит солнце для водителя.

temperature

WeatherUnit

Конкретное значение заданной единицы измерения, связанное с погодой.

wind

WindDetails

Возвращаемые сведения о ветре, включая скорость и направление.

windGust

WindDetails

Возвращаемые сведения о ветре, включая скорость и направление.

WindDetails

Возвращаемые сведения о ветре, включая скорость и направление.

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

WindDirection

Направление ветра

speed

WeatherUnit

Скорость ветра в указанной единице.

WindDirection

Направление ветра

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

integer

Направление ветра в азимутских градусах, начиная с истинного севера и продолжающегося по часовой стрелке. Север 0 градусов, восток 90 градусов, юг 180 градусов, запад 270 градусов. Возможные значения от 0 до 359.

localizedDescription

string

Сокращение направления на указанном языке.