Compartir a través de


Route - Get Route Operations Result

Obtenga el resultado de una operación asincrónica por su identificador de operación.

GET https://atlas.microsoft.com/route/operations/{id}/result?api-version=2025-01-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
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}$

Identificador único generado por el sistema para la operación asincrónica después de que se haya enviado.

api-version
query True

string

Número de versión de la API de Azure Maps.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-id

string

Indica la cuenta destinada a su uso con el modelo de seguridad de identificador de Microsoft Entra. Este identificador único para la cuenta de Azure Maps se puede obtener de la API de cuenta del plano de administración de Azure Maps. Para obtener más información sobre el uso de la seguridad de ID de Microsoft Entra en Azure Maps, consulte Administración de la autenticación en Azure Maps.

Accept-Language

string

Idioma en el que se deben devolver los resultados de enrutamiento.

Para más información, consulte compatibilidad con la localización de en Azure Maps.

Respuestas

Nombre Tipo Description
200 OK RouteOperationResponse:

RouteMatrixAsyncResponse

De acuerdo

404 Not Found

MapsErrorResponse

No se encontró el resultado del recurso de operación.

Encabezados

x-ms-error-code: string

Other Status Codes

MapsErrorResponse

Error inesperado.

Encabezados

x-ms-error-code: string

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0. Cuando se empareja con acceso basado en rol de Azure control, se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o de un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Nota:

  • Esta definición de seguridad requiere el uso del encabezado para indicar a qué recurso de x-ms-client-id Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps.
  • El Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra.
  • El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.
  • El uso de SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
  • Para obtener más información sobre la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Se trata de una clave compartida que se aprovisiona al crear una recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.

Para las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de las API REST de Azure Maps donde esta clave se puede almacenar de forma segura.

Tipo: apiKey
En: header

SAS Token

Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controle el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Retrieve the async matrix result

Solicitud de ejemplo

GET https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2025-01-01

Respuesta de muestra

{
  "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."
  }
}

Definiciones

Nombre Description
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

FeaturesItemTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es Feature. Para obtener más información, consulte RFC 7946.

MapsErrorDetail

Detalle del error.

MapsErrorResponse

Respuesta de error común para las API de Azure Maps para devolver los detalles de error de las operaciones con errores.

MapsInnerError

Objeto que contiene información más específica que el objeto actual sobre el error.

RouteMatrixAsyncResponse

Especifica las instrucciones de conducción y propiedades adicionales para cada punto de maniobra de la pierna de ruta.

RouteMatrixFeatureProperties

Propiedades de la matriz de rutas.

RouteMatrixItemResult

Resultado del elemento Route Matrix

RouteMatrixSummary

Resumen de la solicitud de matriz de rutas

RouteOperationKindEnum

Tipo de operación asincrónica

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.

type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

FeaturesItemTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es Feature. Para obtener más información, consulte RFC 7946.

Valor Description
Feature

Especifica el tipo de objeto feature de GeoJSON.

MapsErrorDetail

Detalle del error.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.

details

MapsErrorDetail[]

Matriz de detalles sobre errores específicos que llevaron a este error notificado.

innererror

MapsInnerError

Objeto que contiene información más específica que el objeto actual sobre el error.

message

string

Una representación en lenguaje natural del error.

target

string

Destino del error.

MapsErrorResponse

Respuesta de error común para las API de Azure Maps para devolver los detalles de error de las operaciones con errores.

Nombre Tipo Description
error

MapsErrorDetail

Detalle del error.

MapsInnerError

Objeto que contiene información más específica que el objeto actual sobre el error.

Nombre Tipo Description
code

string

Código de error.

innererror

MapsInnerError

Objeto que contiene información más específica que el objeto actual sobre el error.

RouteMatrixAsyncResponse

Especifica las instrucciones de conducción y propiedades adicionales para cada punto de maniobra de la pierna de ruta.

Nombre Tipo Description
geometry

object

El objeto geometry es null

kind string:

RouteMatrix

Tipo de operación asincrónica

properties

RouteMatrixFeatureProperties

Propiedades de la matriz de rutas.

type

FeaturesItemTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es Feature. Para obtener más información, consulte RFC 7946.

RouteMatrixFeatureProperties

Propiedades de la matriz de rutas.

Nombre Tipo Description
matrix

RouteMatrixItemResult[]

Matriz de resultados de ruta.

summary

RouteMatrixSummary

Resumen de la solicitud de matriz de rutas

RouteMatrixItemResult

Resultado del elemento Route Matrix

Nombre Tipo Description
arrivalAt

string (date-time)

La hora estimada de llegada, que tiene en cuenta las condiciones de tráfico, tiene el formato de un valor dateTime definido por RFC 3339, sección 5.6. Hará referencia al desplazamiento de zona horaria mediante departAt o arrivalAt. Si no es así, se usará la hora UTC. Si departAt o arriveAt es alguno, entonces departureAt está ausente.

departureAt

string (date-time)

La hora estimada de salida, que tiene en cuenta las condiciones de tráfico, tiene el formato de un valor dateTime definido por RFC 3339, sección 5.6. Hará referencia al desplazamiento de zona horaria mediante departAt o arrivalAt. Si no es así, se usará la hora UTC. Si departAt o arriveAt es any, entonces departureAt está ausente.

destinationIndex

integer (int32)

Índice del punto de destino

distanceInMeters

number (double)

Length In Meters (propiedad)

durationInSeconds

integer (int64)

Tiempo estimado de viaje en segundos que no incluye retrasos en la ruta debido a las condiciones de tráfico.

durationTrafficInSeconds

integer (int64)

El tiempo que tarda, en segundos, en viajar un TravelDistance correspondiente con las condiciones de tráfico actuales. Este valor se proporciona si optimizeRoute incluye consideraciones sobre el tráfico.

error

ErrorDetail

Detalle del error.

originIndex

integer (int32)

Índice del punto de origen

statusCode

integer (int32)

Código de estado HTTP de la celda actual.

RouteMatrixSummary

Resumen de la solicitud de matriz de rutas

Nombre Tipo Description
successfulCount

integer (int32)

Número de rutas correctas dentro de esta matriz.

totalCount

integer (int32)

Número total de rutas dentro de esta matriz.

RouteOperationKindEnum

Tipo de operación asincrónica

Valor Description
RouteMatrix

Trabajo asincrónico de matriz de rutas.