Route - Get Route Operations Result
Obtenha o resultado de uma operação assíncrona por sua ID de operação.
GET https://atlas.microsoft.com/route/operations/{id}/result?api-version=2025-01-01
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
id
|
path | True |
string minLength: 36maxLength: 36 pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Identificador exclusivo gerado pelo sistema para a operação assíncrona depois que ela foi enviada. |
|
api-version
|
query | True |
string |
Número de versão da API do Azure Mapas. |
Cabeçalho da solicitação
| Nome | Obrigatório | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Indica a conta destinada ao uso com o modelo de segurança de ID do Microsoft Entra. Essa ID exclusiva para a conta do Azure Mapas pode ser obtida na API da conta do plano de gerenciamento do Azure Mapas. Para obter mais informações sobre como usar a segurança de ID do Microsoft Entra no Azure Mapas, consulte Gerenciar autenticação no Azure Mapas. |
|
| Accept-Language |
string |
Idioma no qual os resultados do roteamento devem ser retornados. Para obter mais informações, consulte Suporte à Localização no Azure Mapas. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK | RouteOperationResponse: |
OKEY |
| 404 Not Found |
O resultado do recurso de operação não foi encontrado. Cabeçalhos x-ms-error-code: string |
|
| Other Status Codes |
Ocorreu um erro inesperado. Cabeçalhos x-ms-error-code: string |
Segurança
AADToken
Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Mapas.
Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de controlar o acesso em APIs e escopos específicos.
Observação
- Essa definição de segurança requer o uso do cabeçalho
x-ms-client-idpara indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas. - O
Authorization URLé específico para a instância de nuvem pública do Azure. Nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra. - O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
- O uso do SDK da Web do do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
- Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
| Nome | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Essa é uma chave compartilhada provisionada ao criar um recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como chaves mestras para a conta para a qual são emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor a servidor de APIs REST do Azure Mapas, em que essa chave pode ser armazenada com segurança.
Tipo:
apiKey
Em:
header
SAS Token
Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais protegida do que a chave compartilhada.
Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta de mapa de
Tipo:
apiKey
Em:
header
Exemplos
Retrieve the async matrix result
Solicitação de exemplo
GET https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2025-01-01
Resposta de exemplo
{
"kind": "RouteMatrix",
"type": "Feature",
"geometry": null,
"properties": {
"summary": {
"totalCount": 4,
"successfulCount": 2
},
"matrix": [
{
"statusCode": 200,
"originIndex": 0,
"destinationIndex": 0,
"departureAt": "2022-12-19T16:39:57+01:00",
"arrivalAt": "2022-12-20T00:21:14+01:00",
"distanceInMeters": 573064,
"durationInSeconds": 27677,
"durationTrafficInSeconds": 27677
},
{
"statusCode": 400,
"originIndex": 0,
"destinationIndex": 1,
"error": {
"code": "OUT_OF_REGION",
"message": "Input coordinates out of region"
}
},
{
"statusCode": 200,
"originIndex": 1,
"destinationIndex": 0,
"departureAt": "2022-12-19T16:39:57+01:00",
"arrivalAt": "2022-12-19T22:19:10+01:00",
"distanceInMeters": 452488,
"durationInSeconds": 20353,
"durationTrafficInSeconds": 20353
},
{
"statusCode": 400,
"originIndex": 1,
"destinationIndex": 1,
"error": {
"code": "OUT_OF_REGION",
"message": "Input coordinates out of region"
}
}
]
}
}
{
"error": {
"code": "NotFound",
"message": "Not Found: the requested resource could not be found."
}
}
Definições
| Nome | Description |
|---|---|
|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
|
Error |
O detalhe do erro. |
|
Features |
Especifica o tipo de |
|
Maps |
O detalhe do erro. |
|
Maps |
Resposta de erro comum para AS APIs do Azure Mapas retornarem detalhes de erro para operações com falha. |
|
Maps |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
Route |
Especifica as instruções de condução e as propriedades adicionais para cada ponto de manobra na rota Leg. |
|
Route |
Propriedades de Matriz de Rota. |
|
Route |
Resultado do item de Matriz de Rota |
|
Route |
Resumo da solicitação de matriz de rotas |
|
Route |
Tipo de operação assíncrona |
ErrorAdditionalInfo
As informações adicionais do erro de gerenciamento de recursos.
| Nome | Tipo | Description |
|---|---|---|
| info |
object |
As informações adicionais. |
| type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
| Nome | Tipo | Description |
|---|---|---|
| additionalInfo |
As informações adicionais do erro. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O destino do erro. |
FeaturesItemTypeEnum
Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é o Recurso. Para obter mais informações, consulte RFC 7946.
| Valor | Description |
|---|---|
| Feature |
Especifica o tipo de objeto |
MapsErrorDetail
O detalhe do erro.
| Nome | Tipo | Description |
|---|---|---|
| code |
string |
Um de um conjunto definido pelo servidor de códigos de erro. |
| details |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
|
| innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
| message |
string |
Uma representação do erro em formato legível por humanos. |
| target |
string |
O destino do erro. |
MapsErrorResponse
Resposta de erro comum para AS APIs do Azure Mapas retornarem detalhes de erro para operações com falha.
| Nome | Tipo | Description |
|---|---|---|
| error |
O detalhe do erro. |
MapsInnerError
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
| Nome | Tipo | Description |
|---|---|---|
| code |
string |
O código de erro. |
| innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
RouteMatrixAsyncResponse
Especifica as instruções de condução e as propriedades adicionais para cada ponto de manobra na rota Leg.
| Nome | Tipo | Description |
|---|---|---|
| geometry |
object |
O objeto geometry é nulo |
| kind |
string:
Route |
Tipo de operação assíncrona |
| properties |
Propriedades de Matriz de Rota. |
|
| type |
Especifica o tipo de |
RouteMatrixFeatureProperties
Propriedades de Matriz de Rota.
| Nome | Tipo | Description |
|---|---|---|
| matrix |
A matriz de resultados da rota. |
|
| summary |
Resumo da solicitação de matriz de rotas |
RouteMatrixItemResult
Resultado do item de Matriz de Rota
| Nome | Tipo | Description |
|---|---|---|
| arrivalAt |
string (date-time) |
A hora de chegada estimada, que leva em conta as condições de tráfego, é formatada como um valor |
| departureAt |
string (date-time) |
A hora de partida estimada, que leva em conta as condições de tráfego, é formatada como um valor |
| destinationIndex |
integer (int32) |
Índice do ponto de destino |
| distanceInMeters |
number (double) |
Propriedade Length In Meters |
| durationInSeconds |
integer (int64) |
Tempo estimado de viagem em segundos que não inclui atrasos na rota devido às condições de tráfego. |
| durationTrafficInSeconds |
integer (int64) |
O tempo que leva, em segundos, para percorrer um |
| error |
O detalhe do erro. |
|
| originIndex |
integer (int32) |
Índice do ponto de origem |
| statusCode |
integer (int32) |
O código de status HTTP da célula atual. |
RouteMatrixSummary
Resumo da solicitação de matriz de rotas
| Nome | Tipo | Description |
|---|---|---|
| successfulCount |
integer (int32) |
Número de rotas bem-sucedidas nessa matriz. |
| totalCount |
integer (int32) |
Número total de rotas dentro dessa matriz. |
RouteOperationKindEnum
Tipo de operação assíncrona
| Valor | Description |
|---|---|
| RouteMatrix |
Trabalho assíncrono da matriz de rotas. |