Поделиться через


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: 36
maxLength: 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:

RouteMatrixAsyncResponse

Запрос выполнен успешно.

404 Not Found

MapsErrorResponse

Сервер не может найти запрошенный ресурс.

Other Status Codes

MapsErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

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 на ресурсе Azure Maps/c0> через плоскость управления Azure через портал Azure, PowerShell, CLI, Azure SDKs или REST API.\n\n С помощью этого токена любое приложение имеет право на доступ с помощью Azure ролевые контроли доступа и тонкий контроль истечения срока действия, скорости и региона использования конкретного токена. Другими словами, SAS Token может использоваться для того, чтобы приложения могли управлять доступом более защищённо, чем общий ключ.\n\n Для публично открытых приложений мы рекомендуем настроить конкретный список разрешённых источников на ресурсе аккаунта Map , чтобы ограничить злоупотребления рендерингом и регулярно продлевать токен 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."
  }
}

Определения

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

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

ErrorAdditionalInfo

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

FeaturesItemTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является Feature. Дополнительные сведения см. в RFC 7946.

MapsErrorDetail

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

MapsErrorResponse

Распространённый ответ на ошибку для API Azure Maps для возврата деталей ошибок при неудачных операциях.

MapsInnerError

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.

RouteMatrixAsyncResponse

Указывает инструкции по вождению и дополнительные свойства для каждой точки маневра в маршруте Leg.

RouteMatrixFeatureProperties

Свойства матрицы маршрутов.

RouteMatrixItemResult

Результат элемента "Матрица маршрутов"

RouteMatrixSummary

Сводка по запросу матрицы маршрутов

RouteOperationKindEnum

Тип асинхронной операции

CommonErrorDetail

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

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

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

CommonErrorDetail[]

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

message

string

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

target

string

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

ErrorAdditionalInfo

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

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

object

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

type

string

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

FeaturesItemTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является Feature. Дополнительные сведения см. в RFC 7946.

Значение Описание
Feature

Указывает тип объекта компонента GeoJSON.

MapsErrorDetail

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

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

string

Один из определяемых сервером кодов ошибок.

details

MapsErrorDetail[]

Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.

innererror

MapsInnerError

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.

message

string

Читаемое пользователем представление ошибки.

target

string

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

MapsErrorResponse

Распространённый ответ на ошибку для API Azure Maps для возврата деталей ошибок при неудачных операциях.

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

MapsErrorDetail

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

MapsInnerError

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.

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

string

Код ошибки.

innererror

MapsInnerError

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.

RouteMatrixAsyncResponse

Указывает инструкции по вождению и дополнительные свойства для каждой точки маневра в маршруте Leg.

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

Объект geometry имеет значение NULL

kind string:

RouteMatrix

Тип асинхронной операции

properties

RouteMatrixFeatureProperties

Свойства матрицы маршрутов.

type

FeaturesItemTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является Feature. Дополнительные сведения см. в RFC 7946.

RouteMatrixFeatureProperties

Свойства матрицы маршрутов.

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

RouteMatrixItemResult[]

Матрица результатов маршрута.

summary

RouteMatrixSummary

Сводка по запросу матрицы маршрутов

RouteMatrixItemResult

Результат элемента "Матрица маршрутов"

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

string (date-time)

Предполагаемое время прибытия, которое учитывает условия движения, форматируется как dateTime значение, определенное RFC 3339, раздел 5.6. Он будет ссылаться на смещение часового пояса на departAt или arrivalAt. В противном случае будет использоваться время UTC. Если отправление или прибытие есть, то отправление отсутствует.

departureAt

string (date-time)

Предполагаемое время отъезда, которое учитывает условия движения, форматируется как dateTime значение, определенное RFC 3339, раздел 5.6. Он будет ссылаться на смещение часового пояса на departAt или arrivalAt. В противном случае будет использоваться время UTC. Если отправление или прибытие есть any, то отправление отсутствует.

destinationIndex

integer (int32)

Индекс конечной точки

distanceInMeters

number (double)

Свойство Length In Meters

durationInSeconds

integer (int64)

Предполагаемое время поездки в секундах, не включающее задержки в маршруте из-за условий дорожного движения.

durationTrafficInSeconds

integer (int64)

Время, которое требуется, в секундах, для перемещения соответствующего TravelDistance с текущими условиями движения. Это значение предоставляется, если optimizeRoute включает в себя рекомендации по трафику.

error

CommonErrorDetail

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

originIndex

integer (int32)

Индекс точки источника

statusCode

integer (int32)

Код состояния HTTP текущей ячейки.

RouteMatrixSummary

Сводка по запросу матрицы маршрутов

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

integer (int32)

Число успешных маршрутов в этой матрице.

totalCount

integer (int32)

Общее количество маршрутов в этой матрице.

RouteOperationKindEnum

Тип асинхронной операции

Значение Описание
RouteMatrix

Асинхронное задание матрицы маршрутов.