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 {endpoint}/route/operations/{id}/result?api-version=2025-01-01

Parámetros de identificador URI

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

El sistema generó un identificador único para la operación asincrónica una vez enviado.

api-version
query True

string

minLength: 1

Versión de API que se usará para esta operación.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-id

string

Indica la cuenta destinada a usarse con el modelo de seguridad Microsoft Entra ID. Este ID único para la cuenta de Azure Maps puede obtenerse desde la API de la cuenta Azure Maps plano de gestión. Para más información sobre el uso de la seguridad Microsoft Entra ID en Azure Maps, consulte Gestionar 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 Soporte de localización en Azure Maps.

Respuestas

Nombre Tipo Description
200 OK RouteOperationResponse:

RouteMatrixAsyncResponse

La solicitud se ha realizado correctamente.

404 Not Found

MapsErrorResponse

El servidor no encuentra el recurso solicitado.

Other Status Codes

MapsErrorResponse

Una respuesta de error inesperada.

Seguridad

AadToken

Estos son los flujos Microsoft Entra OAuth 2.0. Cuando se combina con el control de acceso basado en roles Azure puede usarse para controlar el acceso a Azure Maps APIs REST. Los controles de acceso basados en roles de Azure se utilizan para designar el acceso a una o más cuentas o subrecursos de recursos de Azure Maps. Cualquier usuario, grupo o principal de servicio puede recibir acceso mediante un rol incorporado o un rol personalizado compuesto por uno o más permisos para Azure Maps APIs REST.\n\nPara implementar escenarios, recomendamos consultar conceptos autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones(es) mediante objetos capaces de control de acceso en APIs y ámbitos específicos.\n\n#### Notas\n* Esta definición de seguridad requiere el uso del encabezado x-ms-client-id para indicar a qué recurso Azure Maps solicita acceso la aplicación. Esto puede obtenerse de la API de gestión Maps.\n* \nEl Authorization URL es específico para la instancia Azure nube pública. Las nubes soberanas tienen URLs de Autorización y configuraciones de Microsoft Entra ID únicas. \n* \nEl control de acceso basado en roles Azure se configura desde el plano de gestión Azure a través de Azure portal, PowerShell, CLI, SDK de Azure o APIs REST.\n* \nUso del Azure Maps Web SDK permite la configuración de una aplicación para múltiples casos de uso.\n* Para más información sobre Plataforma de identidad de Microsoft, véase Plataforma de identidad de Microsoft visión general.

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

subscription-key

Esta es una clave compartida que se provisiona cuando Crea una cuenta Azure Maps en el portal Azure o usando PowerShell, CLI, SDK de Azure o REST API.\n\n Con esta clave, cualquier aplicación puede acceder a toda la API REST. En otras palabras, esta clave puede usarse como una llave maestra en la cuenta en la que se emiten.\n\n Para aplicaciones expuestas públicamente, nuestra recomendación es utilizar el enfoque confidenciales para acceder a Azure Maps APIs REST y así almacenar tu clave de forma segura.

Tipo: apiKey
En: header

SAS Token

Este token de firma de acceso compartido se crea a partir de la operación List SAS en el recurso Azure Maps a través del plano de gestión de Azure mediante Azure portal, PowerShell, CLI, SDK de Azure o APIs REST.\n\n Con este token, cualquier aplicación está autorizada para acceder con Azure controles de acceso basados en roles y control detallado de la expiración, tasa y región(es) de uso para el token en particular. En otras palabras, el Token SAS puede usarse para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.\n\n Para aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta Map para limitar el abuso de renderizado y renovar regularmente el Token SAS.

Tipo: apiKey
En: header

Ejemplos

Retrieve the async matrix result

Solicitud de ejemplo

GET {endpoint}/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2025-01-01

Respuesta de muestra

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

Definiciones

Nombre Description
CommonErrorDetail

Detalle del error.

ErrorAdditionalInfo

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

FeaturesItemTypeEnum

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

MapsErrorDetail

Detalle del error.

MapsErrorResponse

Respuesta común a errores para que las APIs de Azure Maps devolvan detalles de error por operaciones fallidas.

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

CommonErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

CommonErrorDetail[]

Detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

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.

FeaturesItemTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es Feature. Para obtener más información, vea 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 común a errores para que las APIs de Azure Maps devolvan detalles de error por operaciones fallidas.

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

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, vea 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

CommonErrorDetail

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.