Route - Get Route Operations Result

Ottenere il risultato di un'operazione asincrona in base al relativo ID operazione.

GET {endpoint}/route/operations/{id}/result?api-version=2025-01-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
path True

string (uri)

Il nome host del servizio Mappe di Azure. Usa https://atlas.microsoft.com per il cloud pubblico Azure. Per puntare a una specifica Mappe di Azure geografica o a una nuvola sovrana, vedi Mappe di Azure ambito geografico.

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}$

Identificatore univoco generato dal sistema per l'operazione asincrona dopo che è stata inviata.

api-version
query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
x-ms-client-id

string

Indica l'account destinato all'uso con il modello di sicurezza Microsoft Entra ID. Questo ID univoco per l'account Mappe di Azure può essere ottenuto dall'Account API Mappe di Azure piano di gestione. Per maggiori informazioni sull'uso della sicurezza Microsoft Entra ID in Mappe di Azure, vedi Gestire l'autenticazione in Mappe di Azure.

Accept-Language

string

Lingua in cui devono essere restituiti i risultati del routing.

Per maggiori informazioni, consulta Supporto alla localizzazione in Mappe di Azure.

Risposte

Nome Tipo Descrizione
200 OK RouteOperationResponse:

RouteMatrixAsyncResponse

La richiesta ha avuto esito positivo.

404 Not Found

MapsErrorResponse

Il server non riesce a trovare la risorsa richiesta.

Other Status Codes

MapsErrorResponse

Risposta di errore imprevista.

Sicurezza

AadToken

Questi sono i flussi Microsoft Entra OAuth 2.0. Quando abbinata al controllo Azure basato su ruolo può essere utilizzata per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso basati su ruoli di Azure sono utilizzati per designare l'accesso a uno o più account o sottorisorse risorse di Mappe di Azure. A qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per le API REST di Mappe di Azure.

Per implementare scenari, è consigliabile visualizzare concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.

Note

  • Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare a quale risorsa di Mappe di Azure l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione di mappe .
  • Il Authorization URL è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione unici e configurazioni Microsoft Entra ID.
  • Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.
  • L'utilizzo della Sdk Web di Mappe di Azure consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.
  • Per altre informazioni su Microsoft Identity Platform, vedere panoramica di Microsoft Identity Platform.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
https://atlas.microsoft.com/.default

subscription-key

Si tratta di una chiave condivisa di cui viene effettuato il provisioning quando si Creare un account di Mappe di Azure nel portale di Azure o usando PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o l'API REST.

Con questa chiave, qualsiasi applicazione può accedere a tutte le API REST. In altre parole, questa chiave può essere usata come chiave master nell'account in cui vengono rilasciati.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'approccio applicazioni client riservate per accedere alle API REST di Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.

Tipo: apiKey
In: header

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione List SAS nell'risorsa di Mappe di Azure tramite il piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere ai controlli di accesso in base al ruolo di Azure e al controllo granulare per la scadenza, la frequenza e le aree d'uso per il token specifico. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.

Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

Retrieve the async matrix result

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
CommonErrorDetail

Dettagli dell'errore.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

FeaturesItemTypeEnum

Specifica il tipo di GeoJSON. L'unico tipo di oggetto supportato è Feature. Per altre informazioni, vedere RFC 7946.

MapsErrorDetail

Dettagli dell'errore.

MapsErrorResponse

Risposta comune all'errore per le API di Mappe di Azure per restituire dettagli di errore per operazioni fallite.

MapsInnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

RouteMatrixAsyncResponse

Specifica le istruzioni di guida e le proprietà aggiuntive per ogni punto di manovra nel percorso Gamba.

RouteMatrixFeatureProperties

Proprietà della matrice di route.

RouteMatrixItemResult

Risultato dell'elemento Matrice di route

RouteMatrixSummary

Riepilogo per la richiesta della matrice di route

RouteOperationKindEnum

Tipo di operazione asincrona

CommonErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

CommonErrorDetail[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

FeaturesItemTypeEnum

Specifica il tipo di GeoJSON. L'unico tipo di oggetto supportato è Feature. Per altre informazioni, vedere RFC 7946.

Valore Descrizione
Feature

Specifica il tipo di oggetto Feature GeoJSON.

MapsErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.

details

MapsErrorDetail[]

Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.

innererror

MapsInnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

message

string

Rappresentazione leggibile dell'errore.

target

string

Destinazione dell'errore.

MapsErrorResponse

Risposta comune all'errore per le API di Mappe di Azure per restituire dettagli di errore per operazioni fallite.

Nome Tipo Descrizione
error

MapsErrorDetail

Dettagli dell'errore.

MapsInnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

Nome Tipo Descrizione
code

string

Codice di errore.

innererror

MapsInnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

RouteMatrixAsyncResponse

Specifica le istruzioni di guida e le proprietà aggiuntive per ogni punto di manovra nel percorso Gamba.

Nome Tipo Descrizione
geometry

L'oggetto geometry è Null

kind string:

RouteMatrix

Tipo di operazione asincrona

properties

RouteMatrixFeatureProperties

Proprietà della matrice di route.

type

FeaturesItemTypeEnum

Specifica il tipo di GeoJSON. L'unico tipo di oggetto supportato è Feature. Per altre informazioni, vedere RFC 7946.

RouteMatrixFeatureProperties

Proprietà della matrice di route.

Nome Tipo Descrizione
matrix

RouteMatrixItemResult[]

Matrice dei risultati della route.

summary

RouteMatrixSummary

Riepilogo per la richiesta della matrice di route

RouteMatrixItemResult

Risultato dell'elemento Matrice di route

Nome Tipo Descrizione
arrivalAt

string (date-time)

L'ora di arrivo stimata, che tiene conto delle condizioni del traffico, viene formattata come valore dateTime definito da RFC 3339, sezione 5.6. Farà riferimento all'offset del fuso orario departAt o arrivalAt. In caso contrario, verrà usata l'ora UTC. Se departAt o arriveAt è qualsiasi, allora departureAt è assente.

departureAt

string (date-time)

L'ora di partenza stimata, che tiene conto delle condizioni del traffico, viene formattata come valore dateTime definito da RFC 3339, sezione 5.6. Farà riferimento all'offset del fuso orario departAt o arrivalAt. In caso contrario, verrà usata l'ora UTC. Se departAt o arriveAt è any, allora departureAt è assente.

destinationIndex

integer (int32)

Indice del punto di destinazione

distanceInMeters

number (double)

Proprietà Length In Meters

durationInSeconds

integer (int64)

Tempo di viaggio stimato in secondi che non include ritardi sul percorso a causa di condizioni del traffico.

durationTrafficInSeconds

integer (int64)

Tempo necessario, in secondi, per spostarsi in un TravelDistance corrispondente con condizioni di traffico correnti. Questo valore viene fornito se traffic=live viene passato per tenere conto delle condizioni attuali del traffico.

error

CommonErrorDetail

Dettagli dell'errore.

originIndex

integer (int32)

Indice del punto di origine

statusCode

integer (int32)

Codice di stato HTTP della cella corrente.

RouteMatrixSummary

Riepilogo per la richiesta della matrice di route

Nome Tipo Descrizione
successfulCount

integer (int32)

Numero di route riuscite all'interno di questa matrice.

totalCount

integer (int32)

Numero totale di route all'interno di questa matrice.

RouteOperationKindEnum

Tipo di operazione asincrona

Valore Descrizione
RouteMatrix

Processo asincrono della matrice di route.