RequestRouteMatrixSync interface

Paquete:

@azure-rest/maps-route

Métodos

post(RouteRequestRouteMatrixSyncParameters)

Se aplica a: consulte precios niveles. El servicio de enrutamiento de matriz permite calcular una matriz de resúmenes de ruta para un conjunto de rutas definidas por ubicaciones de origen y destino mediante una solicitud POST asincrónica (asincrónica) o sincrónica (sincrónica). Para cada origen determinado, el servicio calcula el costo de enrutamiento desde ese origen a cada destino determinado. El conjunto de orígenes y el conjunto de destinos se pueden considerar como los encabezados de columna y fila de una tabla y cada celda de la tabla contiene los costos de enrutamiento desde el origen hasta el destino de esa celda. Por ejemplo, supongamos que una empresa de entrega de comida tiene 20 conductores y necesitan encontrar el conductor más cercano para recoger la entrega del restaurante. Para resolver este caso de uso, pueden llamar a Matrix Route API. Para cada ruta, se devuelven los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar qué rutas detalladas se van a calcular mediante Route Directions API. El tamaño máximo de una matriz para una solicitud asincrónica es 700 y para la solicitud de sincronización se 100 (el número de orígenes multiplicado por el número de destinos). Enviar solicitud de matriz de ruta sincrónica Si el escenario requiere solicitudes sincrónicas y el tamaño máximo de la matriz es menor o igual que 100, es posible que desee realizar una solicitud sincrónica. El tamaño máximo de una matriz para esta API es 100 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 10x10, 6x8, 9x8 (no es necesario que sea cuadrado). POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key} Enviar solicitud de matriz de ruta asincrónica La API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de enrutamiento relativamente complejas. Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Si waitForResults parámetro de la solicitud se establece en true, el usuario obtendrá una respuesta de 200 si la solicitud ha finalizado en menos de 120 segundos. El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, los ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado). Las respuestas asincrónicas se almacenan durante 14 días. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración. POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key} Esta es una secuencia típica de operaciones asincrónicas: El cliente envía una solicitud POST de matriz de rutas a Azure Maps El servidor responderá con uno de los siguientes elementos: HTTP 202 Accepted: se ha aceptado la solicitud Route Matrix. HTTP Error: se produjo un error al procesar la solicitud route Matrix. Puede ser una solicitud incorrecta 400 o cualquier otro código de estado de error. Si la solicitud de ruta de matriz se aceptó correctamente, el encabezado Location de la respuesta contiene la dirección URL para descargar los resultados de la solicitud. Este URI de estado es similar al siguiente: GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key} El cliente emite una solicitud GET en la dirección URL de descarga obtenida en el paso 3 para descargar los resultados Descargar resultados de sincronización Cuando se realiza una solicitud POST para Route Matrix Sync API, el servicio devuelve el código de respuesta 200 para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante. Descargar resultados asincrónicos Cuando una solicitud emite una respuesta 202 Accepted, la solicitud se procesa mediante nuestra canalización asincrónica. Se le proporcionará una dirección URL para comprobar el progreso de la solicitud asincrónica en el encabezado de ubicación de la respuesta. Este URI de estado es similar al siguiente: GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key} La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de GET. HTTP 202 Accepted: se aceptó la solicitud de matriz, pero todavía se está procesando. Inténtelo de nuevo en algún momento. HTTP 200 OK: solicitud de matriz procesada correctamente. El cuerpo de la respuesta contiene todos los resultados.

Detalles del método

post(RouteRequestRouteMatrixSyncParameters)

Se aplica a: consulte precios niveles.

El servicio de enrutamiento de matriz permite calcular una matriz de resúmenes de ruta para un conjunto de rutas definidas por ubicaciones de origen y destino mediante una solicitud POST asincrónica (asincrónica) o sincrónica (sincrónica). Para cada origen determinado, el servicio calcula el costo de enrutamiento desde ese origen a cada destino determinado. El conjunto de orígenes y el conjunto de destinos se pueden considerar como los encabezados de columna y fila de una tabla y cada celda de la tabla contiene los costos de enrutamiento desde el origen hasta el destino de esa celda. Por ejemplo, supongamos que una empresa de entrega de comida tiene 20 conductores y necesitan encontrar el conductor más cercano para recoger la entrega del restaurante. Para resolver este caso de uso, pueden llamar a Matrix Route API.

Para cada ruta, se devuelven los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar qué rutas detalladas se van a calcular mediante Route Directions API.

El tamaño máximo de una matriz para una solicitud asincrónica es 700 y para la solicitud de sincronización se 100 (el número de orígenes multiplicado por el número de destinos).

Enviar solicitud de matriz de ruta sincrónica

Si el escenario requiere solicitudes sincrónicas y el tamaño máximo de la matriz es menor o igual que 100, es posible que desee realizar una solicitud sincrónica. El tamaño máximo de una matriz para esta API es 100 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 10x10, 6x8, 9x8 (no es necesario que sea cuadrado).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitud de matriz de ruta asincrónica

La API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de enrutamiento relativamente complejas. Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Si waitForResults parámetro de la solicitud se establece en true, el usuario obtendrá una respuesta de 200 si la solicitud ha finalizado en menos de 120 segundos.

El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, los ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado).

Las respuestas asincrónicas se almacenan durante 14 días. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Esta es una secuencia típica de operaciones asincrónicas:

1. El cliente envía una solicitud POST de matriz de rutas a Azure Maps

2. El servidor responderá con uno de los siguientes elementos:

   HTTP 202 Accepted: se ha aceptado la solicitud Route Matrix.

   HTTP Error: se produjo un error al procesar la solicitud route Matrix. Puede ser una solicitud incorrecta 400 o cualquier otro código de estado de error.

3. Si la solicitud de ruta de matriz se aceptó correctamente, el encabezado Location de la respuesta contiene la dirección URL para descargar los resultados de la solicitud. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

4. El cliente emite una solicitud GET en la dirección URL de descarga obtenida en el paso 3 para descargar los resultados

Descargar resultados de sincronización

Cuando se realiza una solicitud POST para Route Matrix Sync API, el servicio devuelve el código de respuesta 200 para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante.

Descargar resultados asincrónicos

Cuando una solicitud emite una respuesta 202 Accepted, la solicitud se procesa mediante nuestra canalización asincrónica. Se le proporcionará una dirección URL para comprobar el progreso de la solicitud asincrónica en el encabezado de ubicación de la respuesta. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de GET.

HTTP 202 Accepted: se aceptó la solicitud de matriz, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

HTTP 200 OK: solicitud de matriz procesada correctamente. El cuerpo de la respuesta contiene todos los resultados.

function post(options: RouteRequestRouteMatrixSyncParameters): StreamableMethod<RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse>

Parámetros

options

RouteRequestRouteMatrixSyncParameters

Devoluciones

StreamableMethod<RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse>