Route - Get Route Operations Result
Получите результат асинхронной операции по идентификатору операции.
GET {endpoint}/route/operations/{id}/result?api-version=2025-01-01
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
|
|
id
|
path | True |
string minLength: 36maxLength: 36 pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Система генерирует уникальный идентификатор для асинхронной операции после ее отправки. |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
Заголовок запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| x-ms-client-id |
string |
Указывает аккаунт, предназначенный для использования с моделью безопасности Microsoft Entra ID. Этот уникальный идентификатор для Azure Maps аккаунта можно получить с управляющего плана Azure Maps Account API. Для получения дополнительной информации об использовании Microsoft Entra ID безопасности в Azure Maps см. раздел Управление аутентификацией в Azure Maps. |
|
| Accept-Language |
string |
Язык, в котором должны быть возвращены результаты маршрутизации. Для получения дополнительной информации см. поддержка локализации в Azure Maps. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK | RouteOperationResponse: |
Запрос выполнен успешно. |
| 404 Not Found |
Сервер не может найти запрошенный ресурс. |
|
| Other Status Codes |
Непредвиденное сообщение об ошибке. |
Безопасность
AadToken
Это Microsoft Entra OAuth 2.0 потоки. В сочетании с управлением Azure ролевым доступом он может использоваться для управления доступом к Azure Maps REST API. Ролевые контроли доступа Azure используются для обозначения доступа к одной или нескольким учетной записи ресурсов или подресурсам Azure Maps. Любой пользователь, группа или принципал сервиса может получить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений Azure Maps REST API.\n\nДля реализации сценариев рекомендуем ознакомиться с концепциями аутентификационные концепции. В заключение, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных контролировать доступ к определённым API и областям видимости.\n\n#### Примечания\n* Это определение безопасности требует использование заголовка x-ms-client-id для указания, к какому Azure Maps ресурсу приложение запрашивает доступ. Её можно получить через API управления Maps.\n* \nAuthorization URL специфичен для экземпляра публичного облака Azure. Облака Sovereign имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. \n* \nУправление доступом на основе ролей Azure настраивается с плоскости управления Azure через портал Azure, PowerShell, CLI, Azure SDKs или REST API.\n* \nИспользование Azure Maps Web SDK позволяет настраивать приложение на основе конфигурации для нескольких сценариев использования.\n* Для получения дополнительной информации о платформа удостоверений Майкрософт см. платформа удостоверений Майкрософт обзор.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Это общий ключ, который создаётся при Создайте Azure Maps аккаунт в Azure-портале или с помощью PowerShell, CLI, Azure SDKs или REST API.\n\n С помощью этого ключа любое приложение может получить доступ ко всем REST API. Другими словами, этот ключ может использоваться как мастер-ключ на счете, на котором они выпущены.\n\n Для публично открытых приложений мы рекомендуем использовать подход confidential client applications для доступа к Azure Maps REST API, чтобы ваш ключ можно было безопасно хранить.
Тип:
apiKey
В:
header
SAS Token
Это токен общего доступа, созданный из операции List SAS на ресурсе
Тип:
apiKey
В:
header
Примеры
Retrieve the async matrix result
Образец запроса
GET {endpoint}/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2025-01-01
Пример ответа
{
"type": "Feature",
"geometry": null,
"kind": "RouteMatrix",
"properties": {
"matrix": [
{
"arrivalAt": "2022-12-20T00:21:14+01:00",
"departureAt": "2022-12-19T16:39:57+01:00",
"destinationIndex": 0,
"distanceInMeters": 573064,
"durationInSeconds": 27677,
"durationTrafficInSeconds": 27677,
"originIndex": 0,
"statusCode": 200
},
{
"destinationIndex": 1,
"error": {
"code": "OUT_OF_REGION",
"message": "Input coordinates out of region"
},
"originIndex": 0,
"statusCode": 400
},
{
"arrivalAt": "2022-12-19T22:19:10+01:00",
"departureAt": "2022-12-19T16:39:57+01:00",
"destinationIndex": 0,
"distanceInMeters": 452488,
"durationInSeconds": 20353,
"durationTrafficInSeconds": 20353,
"originIndex": 1,
"statusCode": 200
},
{
"destinationIndex": 1,
"error": {
"code": "OUT_OF_REGION",
"message": "Input coordinates out of region"
},
"originIndex": 1,
"statusCode": 400
}
],
"summary": {
"successfulCount": 2,
"totalCount": 4
}
}
}
{
"error": {
"code": "NotFound",
"message": "Not Found: the requested resource could not be found."
}
}
Определения
| Имя | Описание |
|---|---|
|
Common |
Сведения об ошибке. |
|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
|
Features |
Указывает тип |
|
Maps |
Сведения об ошибке. |
|
Maps |
Распространённый ответ на ошибку для API Azure Maps для возврата деталей ошибок при неудачных операциях. |
|
Maps |
Объект, содержащий более конкретные сведения, чем текущий объект об ошибке. |
|
Route |
Указывает инструкции по вождению и дополнительные свойства для каждой точки маневра в маршруте Leg. |
|
Route |
Свойства матрицы маршрутов. |
|
Route |
Результат элемента "Матрица маршрутов" |
|
Route |
Сводка по запросу матрицы маршрутов |
|
Route |
Тип асинхронной операции |
CommonErrorDetail
Сведения об ошибке.
| Имя | Тип | Описание |
|---|---|---|
| additionalInfo |
Дополнительные сведения об ошибке. |
|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке. |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект ошибки. |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
| Имя | Тип | Описание |
|---|---|---|
| info |
object |
Дополнительные сведения. |
| type |
string |
Дополнительный тип сведений. |
FeaturesItemTypeEnum
Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является Feature. Дополнительные сведения см. в RFC 7946.
| Значение | Описание |
|---|---|
| Feature |
Указывает тип объекта компонента |
MapsErrorDetail
Сведения об ошибке.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Один из определяемых сервером кодов ошибок. |
| details |
Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке. |
|
| innererror |
Объект, содержащий более конкретные сведения, чем текущий объект об ошибке. |
|
| message |
string |
Читаемое пользователем представление ошибки. |
| target |
string |
Целевой объект ошибки. |
MapsErrorResponse
Распространённый ответ на ошибку для API Azure Maps для возврата деталей ошибок при неудачных операциях.
| Имя | Тип | Описание |
|---|---|---|
| error |
Сведения об ошибке. |
MapsInnerError
Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки. |
| innererror |
Объект, содержащий более конкретные сведения, чем текущий объект об ошибке. |
RouteMatrixAsyncResponse
Указывает инструкции по вождению и дополнительные свойства для каждой точки маневра в маршруте Leg.
| Имя | Тип | Описание |
|---|---|---|
| geometry |
Объект geometry имеет значение NULL |
|
| kind |
string:
Route |
Тип асинхронной операции |
| properties |
Свойства матрицы маршрутов. |
|
| type |
Указывает тип |
RouteMatrixFeatureProperties
Свойства матрицы маршрутов.
| Имя | Тип | Описание |
|---|---|---|
| matrix |
Матрица результатов маршрута. |
|
| summary |
Сводка по запросу матрицы маршрутов |
RouteMatrixItemResult
Результат элемента "Матрица маршрутов"
| Имя | Тип | Описание |
|---|---|---|
| arrivalAt |
string (date-time) |
Предполагаемое время прибытия, которое учитывает условия движения, форматируется как |
| departureAt |
string (date-time) |
Предполагаемое время отъезда, которое учитывает условия движения, форматируется как |
| destinationIndex |
integer (int32) |
Индекс конечной точки |
| distanceInMeters |
number (double) |
Свойство Length In Meters |
| durationInSeconds |
integer (int64) |
Предполагаемое время поездки в секундах, не включающее задержки в маршруте из-за условий дорожного движения. |
| durationTrafficInSeconds |
integer (int64) |
Время, которое требуется, в секундах, для перемещения соответствующего |
| error |
Сведения об ошибке. |
|
| originIndex |
integer (int32) |
Индекс точки источника |
| statusCode |
integer (int32) |
Код состояния HTTP текущей ячейки. |
RouteMatrixSummary
Сводка по запросу матрицы маршрутов
| Имя | Тип | Описание |
|---|---|---|
| successfulCount |
integer (int32) |
Число успешных маршрутов в этой матрице. |
| totalCount |
integer (int32) |
Общее количество маршрутов в этой матрице. |
RouteOperationKindEnum
Тип асинхронной операции
| Значение | Описание |
|---|---|
| RouteMatrix |
Асинхронное задание матрицы маршрутов. |