Route - Post Route Range
API диапазона маршрутов создает многоугольник, показывающий область, доступную из заданного расположения в пределах определенного порогового значения в зависимости от указанного бюджета времени или расстояния. Граница многоугольника (или Isochrone) возвращается в ориентации по счетчику, а также в точном центре многоугольников, который был результатом точки источника.
Возвращаемый многоугольник можно использовать для пространственной фильтрации для поиска признаков, интересующих вас в предоставленном Isochrone.
Сведения о доступности маршрутизации в странах и регионах см. в покрытия маршрутизации Azure Maps.
POST https://atlas.microsoft.com/route/range?api-version=2025-01-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
api-version
|
query | True |
string |
Номер версии API Azure Maps. |
Заголовок запроса
Media Types: "application/geo+json"
Имя | Обязательно | Тип | Описание |
---|---|---|---|
x-ms-client-id |
string |
Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности идентификатора Microsoft Entra. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Сведения о том, как использовать безопасность идентификатора Microsoft Entra в Azure Maps, см. в следующих статьях |
Текст запроса
Media Types: "application/geo+json"
Имя | Обязательно | Тип | Описание |
---|---|---|---|
geometry | True |
Указывает объект |
|
properties | True |
Указывает параметры, используемые для вычисления многоугольника isochrone. |
|
type | True |
Указывает тип |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
ХОРОШО Media Types: "application/geo+json", "application/json" |
|
Other Status Codes |
Произошла непредвиденная ошибка. Media Types: "application/geo+json", "application/json" Заголовки x-ms-error-code: string |
Безопасность
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 с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
С помощью этого ключа любой приложению разрешен доступ ко всем REST API. Другими словами, они в настоящее время могут рассматриваться как главные ключи учетной записи, для которой они выданы.
Для общедоступных приложений мы рекомендуем использовать доступ к REST API Azure Maps на сервере, где этот ключ можно безопасно хранить.
Тип:
apiKey
В:
header
SAS Token
Это маркер подписанного URL-адреса создается из операции SAS списка на ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
С помощью этого маркера любой приложению разрешен доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Другими словами, маркер SAS можно использовать для разрешения приложений управлять доступом более защищенным способом, чем общий ключ.
Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты карты, чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.
Тип:
apiKey
В:
header
Примеры
Successfully retrieve a set of locations that can be reached from the origin point based on the specified conditions
Образец запроса
POST https://atlas.microsoft.com/route/range?api-version=2025-01-01
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
5.86605,
50.9745
]
},
"properties": {
"timeBudgetInSec": 6000
}
}
Пример ответа
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
5.86605,
50.9745
]
},
"properties": {
"type": "center"
}
},
{
"type": "Feature",
"bbox": [
3.62838,
49.83259,
7.9826,
52.25674
],
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
5.73602,
52.03704
],
[
5.59435,
52.09456
],
[
5.42279,
52.16815
],
[
5.21276,
52.25047
],
[
5.15355,
52.21374
],
[
4.96687,
52.25674
],
[
4.739,
52.07834
],
[
4.72513,
52.05647
],
[
4.53237,
51.94553
],
[
4.31165,
51.70119
],
[
4.28917,
51.5837
],
[
3.82685,
51.48463
],
[
3.62838,
51.21096
],
[
3.89244,
50.6814
],
[
3.93493,
50.66791
],
[
3.98156,
50.49042
],
[
4.47995,
50.30944
],
[
4.60502,
50.24448
],
[
4.89999,
50.24467
],
[
5.04206,
50.08735
],
[
5.23042,
49.99214
],
[
5.40994,
49.88478
],
[
5.46178,
49.85797
],
[
5.7196,
49.86279
],
[
5.74151,
49.83259
],
[
5.9387,
50.22239
],
[
6.08535,
50.0011
],
[
6.12089,
50.04616
],
[
6.28373,
50.09472
],
[
6.51654,
49.95863
],
[
6.61034,
50.00485
],
[
6.70295,
50.00587
],
[
6.65865,
50.2947
],
[
6.79276,
50.36903
],
[
7.32163,
50.31614
],
[
7.58782,
50.36737
],
[
7.7626,
50.46919
],
[
7.9826,
50.96246
],
[
7.55924,
51.07086
],
[
7.58138,
51.36614
],
[
7.67861,
51.52015
],
[
7.35175,
51.65781
],
[
7.21664,
51.81916
],
[
7.0467,
51.9587
],
[
6.67267,
51.82713
],
[
6.48424,
51.81133
],
[
6.27316,
51.9368
],
[
6.14452,
52.01701
],
[
6.09312,
52.20847
],
[
6.01297,
52.23705
],
[
5.86605,
50.9745
],
[
5.73602,
52.03704
]
]
]
},
"properties": {
"type": "boundary"
}
}
]
}
Определения
Имя | Описание |
---|---|
Adr |
Код ограничения туннеля ADR. ADR — это европейское соглашение о международной перевозке опасных товаров по дороге. Код ограничения туннеля ADR используется для определения того, разрешено ли транспортному средству проходить через туннель с ограничениями на перевозки опасных товаров. |
Features |
Указывает тип |
Feature |
Указывает тип |
Input |
Указывает параметры, используемые для вычисления многоугольника isochrone. |
Maps |
Сведения об ошибке. |
Maps |
Распространенный ответ об ошибке для API Azure Maps для возврата сведений об ошибке для неудачных операций. |
Maps |
Объект, содержащий более конкретные сведения, чем текущий объект об ошибке. |
Route |
Указывает ограничения, которые вычисление маршрута должно учитывать при определении доступных расположений. Избегайте поддержки нескольких значений в запросе. Пример: "избегайте": ["limitedAccessHighways", "tollRoads"] |
Route |
Свойства диапазонов маршрутов. |
Route |
Объект функции GeoJSON, содержащий объект Geometry и дополнительные свойства маршрута. |
Route |
Задает параметр, используемый для оптимизации маршрута. Если значение не определено, значение по умолчанию — fastestWithoutTraffic, которое возвращает маршрут, чтобы свести к минимуму время путешествия без использования текущей информации о трафике. Пример: "optimizeRoute":"shortest" |
Route |
Указывает объект |
Route |
Указывает объект |
Route |
Указывает начальную точку для вычисления диапазона.
|
Route |
Этот объект возвращается из успешного вызова. |
Route |
Указывает профиль перемещения, который следует учитывать при вычислении многоугольника диапазона. Если значение по умолчанию не указано, значение по умолчанию — "вождение". Пример: "travelMode":"driving" |
Route |
Типы функций для объектов признаков, возвращаемых в ответе. |
Route |
Указывает атрибуты транспортного средства, такие как высота транспортного средства, вес, максимальная скорость, тип груза и т. д., которые следует учитывать при вычислении доступных расположений. Это помогает избежать низких разрешений моста, ограничений дорожного движения, трудных поворотов, чтобы обеспечить оптимизированный маршрут грузовика на основе спецификаций транспортного средства. Атрибуты транспортного средства указываются в свойстве VehicleSpec. |
Vehicle |
Типы грузов, которые могут быть классифицированы как опасные материалы и ограничены некоторыми дорогами. Доступные значения vehicleLoadType — это классы US Hazmat 1–9, а также универсальные классификации для использования в других странах. Значения, начиная с USHazmat, предназначены для маршрутизации в США, а другие Хазматы должны использоваться для всех других стран. vehicleLoadType поддерживает несколько значений в запросе. |
AdrTunnelRestrictionCodeEnum
Код ограничения туннеля ADR. ADR — это европейское соглашение о международной перевозке опасных товаров по дороге. Код ограничения туннеля ADR используется для определения того, разрешено ли транспортному средству проходить через туннель с ограничениями на перевозки опасных товаров.
Значение | Описание |
---|---|
B |
Транспортные средства с кодом B ограничены дорогами с категориями B, C, D и E. |
C |
Транспортные средства с кодом C ограничены дорогами с категориями ADR туннеля C, D и E |
D |
Транспортные средства с кодом D ограничены дорогами с категориями D и E. |
E |
Транспортные средства с кодом E ограничены дорогами с категорией E туннеля ADR. |
FeaturesItemTypeEnum
Указывает тип GeoJSON
. Единственным поддерживаемым типом объекта является Feature. Дополнительные сведения см. в RFC 7946.
Значение | Описание |
---|---|
Feature |
Указывает тип объекта компонента |
FeatureTypeEnum
Указывает тип GeoJSON
. Единственным поддерживаемым типом объекта является FeatureCollection
. Дополнительные сведения см. в RFC 7946.
Значение | Описание |
---|---|
FeatureCollection |
Указывает тип объекта |
InputRouteRangeProperties
Указывает параметры, используемые для вычисления многоугольника isochrone.
Имя | Тип | Default value | Описание |
---|---|---|---|
avoid |
Указывает ограничения, которые вычисление маршрута должно учитывать при определении доступных расположений. Избегайте поддержки нескольких значений в запросе. Пример: "избегайте": ["limitedAccessHighways", "tollRoads"] |
||
departAt |
string (date-time) |
Дата и время отъезда из точки источника, отформатированная как значение dateTime, определенное RFC 3339, раздел 5.6. Если смещение часового пояса не указано, предполагается, что в формате UTC. Если Пример: "departAt": "2023-06-01T09:30:00.000-07:00" |
|
distanceBudgetInMeters |
number (float) minimum: 0maximum: 500000 |
Бюджет расстояния задает максимальный диапазон в метрах, который можно перемещать из точки пути источника. Его нельзя задать при указании Максимальное расстояние, поддерживаемого, составляет 500 000 метров. Пример: "distanceBudgetInMeters":5000 |
|
isSimplifiedPolygon |
boolean |
True |
Используйте это, чтобы указать, требуются ли упрощенные многоугольники, уменьшая количество вершин при сохранении общей фигуры.
|
optimizeRoute | fastestWithoutTraffic |
Задает параметр, используемый для оптимизации маршрута. Если значение не определено, значение по умолчанию — fastestWithoutTraffic, которое возвращает маршрут, чтобы свести к минимуму время путешествия без использования текущей информации о трафике. Пример: "optimizeRoute":"shortest" |
|
timeBudgetInSec |
number (float) minimum: 0maximum: 21600 |
Бюджет времени указывает максимальное время в секундах, доступное для путешествий, определяющее, насколько далеко можно пройти в течение этого ограничения времени от точки пути источника. Его нельзя задать при указании Максимальное время, поддерживаемого, составляет 21 600 секунд. Пример: timeBudgetInSec:3600 |
|
travelMode | driving |
Указывает профиль перемещения, который следует учитывать при вычислении многоугольника диапазона. Если значение по умолчанию не указано, значение по умолчанию — "вождение". Пример: "travelMode":"driving" |
|
vehicleSpec |
Указывает атрибуты транспортного средства, такие как высота транспортного средства, вес, максимальная скорость, тип груза и т. д., которые следует учитывать при вычислении доступных расположений. Это помогает избежать низких разрешений моста, ограничений дорожного движения, трудных поворотов, чтобы обеспечить оптимизированный маршрут грузовика на основе спецификаций транспортного средства. Атрибуты транспортного средства указываются в свойстве VehicleSpec. |
MapsErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
code |
string |
Один из определяемых сервером кодов ошибок. |
details |
Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке. |
|
innererror |
Объект, содержащий более конкретные сведения, чем текущий объект об ошибке. |
|
message |
string |
Читаемое пользователем представление ошибки. |
target |
string |
Целевой объект ошибки. |
MapsErrorResponse
Распространенный ответ об ошибке для API Azure Maps для возврата сведений об ошибке для неудачных операций.
Имя | Тип | Описание |
---|---|---|
error |
Сведения об ошибке. |
MapsInnerError
Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки. |
innererror |
Объект, содержащий более конкретные сведения, чем текущий объект об ошибке. |
RouteRangeAvoidEnum
Указывает ограничения, которые вычисление маршрута должно учитывать при определении доступных расположений. Избегайте поддержки нескольких значений в запросе.
Пример: "избегайте": ["limitedAccessHighways", "tollRoads"]
Значение | Описание |
---|---|
borderCrossings |
Избегает пересечения границ страны в маршруте. |
carTrains |
Избегает поездов автомобилей. |
carpools |
Избегает маршрутов, требующих использования carpool. |
ferries |
Избегает использования паромов в маршруте. |
limitedAccessHighways |
Избегает использования ограниченных шоссе доступа в маршруте. |
lowEmissionZones |
Избегает зон с низким уровнем выбросов в маршруте. |
tollRoads |
Избегает использования платных дорог в маршруте. |
tunnels |
Избегает использования туннелей в маршруте. |
unpavedRoads |
Избегает неотложных дорог в маршруте. |
RouteRangeFeatureProperties
Свойства диапазонов маршрутов.
Имя | Тип | Описание |
---|---|---|
type |
Типы функций для объектов признаков, возвращаемых в ответе. |
RouteRangeFeaturesItem
Объект функции GeoJSON, содержащий объект Geometry и дополнительные свойства маршрута.
Имя | Тип | Описание |
---|---|---|
bbox |
number[] (double) |
Прямоугольная область на земле, определенная как ограничивающий прямоугольник. Стороны прямоугольников определяются значениями широты и долготы. Дополнительные сведения см. в разделе RFC 7946, раздел 5. Пример: "bbox": [-10.0, -10.0, 10.0, 10.0] |
geometry | RouteRangeGeometry: |
Допустимый объект |
properties |
Свойства диапазонов маршрутов. |
|
type |
Указывает тип |
RouteRangeOptimizeRouteEnum
Задает параметр, используемый для оптимизации маршрута. Если значение не определено, значение по умолчанию — fastestWithoutTraffic, которое возвращает маршрут, чтобы свести к минимуму время путешествия без использования текущей информации о трафике.
Пример: "optimizeRoute":"shortest"
Значение | Описание |
---|---|
fastestWithTraffic |
Маршрут вычисляется, чтобы свести к минимуму время с использованием текущей информации о трафике.
|
fastestWithoutTraffic |
Находит самый быстрый маршрут, не учитывая сведения о трафике. |
shortest |
Маршрут вычисляется, чтобы свести к минимуму расстояние. Сведения о трафике не используются. |
RouteRangePointGeometry
Указывает объект GeoJSON
Point Geometry. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
coordinates |
number[] (double) |
|
type |
string:
Point |
Задает тип геометрии для объекта |
RouteRangePolygonGeometry
Указывает объект GeoJSON
Polygon Geometry. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
coordinates |
number[] (double) |
Координаты для типа геометрии |
type |
string:
Polygon |
Задает тип геометрии для объекта |
RouteRangeRequest
Указывает начальную точку для вычисления диапазона.
GeoJSON
объект компонента и дополнительные свойства. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
geometry |
Указывает объект |
|
properties |
Указывает параметры, используемые для вычисления многоугольника isochrone. |
|
type |
Указывает тип |
RouteRangeResponse
Этот объект возвращается из успешного вызова.
Имя | Тип | Описание |
---|---|---|
features |
|
|
type |
Указывает тип |
RouteRangeTravelModeEnum
Указывает профиль перемещения, который следует учитывать при вычислении многоугольника диапазона. Если значение по умолчанию не указано, значение по умолчанию — "вождение".
Пример: "travelMode":"driving"
Значение | Описание |
---|---|
driving |
Профиль маршрутизации, подходящий для автомобилей, используется для вычисления многоугольника диапазона. |
truck |
Профиль маршрутизации, подходящий для коммерческих транспортных средств, таких как грузовики, используются для вычисления многоугольника диапазона. |
RouteRangeTypeEnum
Типы функций для объектов признаков, возвращаемых в ответе.
Значение | Описание |
---|---|
boundary |
Тип функции границы представляет многоугольник диапазона. |
center |
Тип функции центра точки представляет точку, используемую для вычисления многоугольника диапазона. |
RouteRangeVehicleSpec
Указывает атрибуты транспортного средства, такие как высота транспортного средства, вес, максимальная скорость, тип груза и т. д., которые следует учитывать при вычислении доступных расположений. Это помогает избежать низких разрешений моста, ограничений дорожного движения, трудных поворотов, чтобы обеспечить оптимизированный маршрут грузовика на основе спецификаций транспортного средства. Атрибуты транспортного средства указываются в свойстве VehicleSpec.
Имя | Тип | Default value | Описание |
---|---|---|---|
adrTunnelRestrictionCode |
Код ограничения туннеля ADR. ADR — это европейское соглашение о международной перевозке опасных товаров по дороге. Код ограничения туннеля ADR используется для определения того, разрешено ли транспортному средству проходить через туннель с ограничениями на перевозки опасных товаров. |
||
axleCount |
integer (int64) |
Количество осей на транспортном средстве. |
|
axleWeight |
integer (int64) minimum: 0maximum: 1000000 |
0 |
Вес на ось транспортного средства в кг. Значение 0 означает, что ограничения веса на ось не считаются. |
height |
number (double) minimum: 0maximum: 1000000 |
0 |
Высота транспортного средства в метрах. Значение 0 означает, что ограничения высоты не учитываются. |
isVehicleCommercial |
boolean |
False |
Используется ли автомобиль для коммерческих целей. Коммерческие транспортные средства могут быть запрещены ездить на некоторых дорогах. |
length |
number (double) minimum: 0maximum: 1000000 |
0 |
Длина транспортного средства в метрах. Значение 0 означает, что ограничения длины не учитываются. |
loadType |
Типы грузов, которые могут быть классифицированы как опасные материалы и ограничены некоторыми дорогами. Доступные значения vehicleLoadType — это классы US Hazmat 1–9, а также универсальные классификации для использования в других странах. Значения, начиная с USHazmat, предназначены для маршрутизации в США, а другие Хазматы должны использоваться для всех других стран. vehicleLoadType поддерживает несколько значений в запросе. |
||
maxSpeed |
integer (int64) minimum: 0maximum: 250 |
0 |
Максимальная скорость транспортного средства в км/час. Максимальная скорость в профиле транспортного средства используется для проверки того, разрешено ли транспортное средство на автомагистралях. Значение 0 означает, что соответствующее значение для транспортного средства будет определено и применено во время планирования маршрута. Значение, отличное от нуля, может быть переопределено во время планирования маршрутов. Например, текущий поток трафика составляет 60 км/час. Если максимальная скорость транспортного средства составляет 50 км/час, подсистема маршрутизации будет учитывать 60 км/час, так как это текущая ситуация. Если максимальная скорость транспортного средства предоставляется как 80 км/час, но текущий поток движения составляет 60 км/час, то подсистема маршрутизации снова будет использовать 60 км/час. |
weight |
integer (int64) minimum: 0maximum: 1000000 |
0 |
Вес транспортного средства в килограммах. Значение 0 означает, что ограничения веса не учитываются. |
width |
number (double) minimum: 0maximum: 1000000 |
0 |
Ширина транспортного средства в метрах. Значение 0 означает, что ограничения ширины не учитываются. |
VehicleLoadTypeEnum
Типы грузов, которые могут быть классифицированы как опасные материалы и ограничены некоторыми дорогами. Доступные значения vehicleLoadType — это классы US Hazmat 1–9, а также универсальные классификации для использования в других странах. Значения, начиная с USHazmat, предназначены для маршрутизации в США, а другие Хазматы должны использоваться для всех других стран. vehicleLoadType поддерживает несколько значений в запросе.
Значение | Описание |
---|---|
USHazmatClass1 |
Взрывчатка |
USHazmatClass2 |
Сжатый газ |
USHazmatClass3 |
Воспламеняемые жидкости |
USHazmatClass4 |
Воспламеняемые твердые вещества |
USHazmatClass5 |
Окислители |
USHazmatClass6 |
Противоядия |
USHazmatClass7 |
Радиоактивный |
USHazmatClass8 |
Корросивы |
USHazmatClass9 |
Разное |
otherHazmatExplosive |
Взрывчатка |
otherHazmatGeneral |
Разное |
otherHazmatHarmfulToWater |
Вредно для воды |