Route - Get Route Operations Result
Ottenere il risultato di un'operazione asincrona in base al relativo ID operazione.
GET https://atlas.microsoft.com/route/operations/{id}/result?api-version=2025-01-01
Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
id
|
path | True |
string minLength: 36maxLength: 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 |
Numero di versione di Azure Maps API. |
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 Azure Maps può essere ottenuto dall'Account API Azure Maps piano di gestione. Per maggiori informazioni sull'uso della sicurezza Microsoft Entra ID in Azure Maps, vedi Gestire l'autenticazione in Azure Maps. |
|
| Accept-Language |
string |
Lingua in cui devono essere restituiti i risultati del routing. Per maggiori informazioni, consulta Supporto alla localizzazione in Azure Maps. |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK | RouteOperationResponse: |
Va bene |
| 404 Not Found |
Il risultato della risorsa dell'operazione non è stato trovato. Intestazioni x-ms-error-code: string |
|
| Other Status Codes |
Errore imprevisto. Intestazioni x-ms-error-code: string |
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 Azure Maps. I controlli di accesso basati su ruoli di Azure sono utilizzati per designare l'accesso a uno o più account o sottorisorse risorse di Azure Maps. Qualsiasi utente, gruppo o principale di servizio può ricevere l'accesso tramite un ruolo integrato o un ruolo personalizzato composto da uno o più permessi alle API REST di Azure Maps.
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.
Annotazioni
- Questa definizione di sicurezza richiede l'uso dell'intestazione
x-ms-client-idper indicare a quale Azure Maps risorsa l'applicazione richiede accesso. Questa operazione può essere acquisita dall'API di gestione di mappe . - Il
Authorization URLè specifico per l'istanza Azure cloud pubblico. I cloud sovrani hanno URL di autorizzazione unici e configurazioni Microsoft Entra ID. - Il controllo degli accessi basato sul ruolo Azure viene configurato dal piano di gestione Azure tramite portale Azure, PowerShell, CLI, Azure SDKs o API REST.
- L'uso del Web SDK Azure Maps consente la 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 | https://atlas.microsoft.com/.default |
subscription-key
Questa è una chiave condivisa che viene fornita quando si crea una risorsa Azure Maps tramite il piano di gestione Azure tramite Azure portale, PowerShell, CLI, Azure SDKs o API REST.
Con questa chiave, qualsiasi applicazione è autorizzata ad accedere a tutte le API REST. In altre parole, questi possono essere attualmente considerati chiavi master per l'account per cui vengono rilasciati.
Per applicazioni pubblicamente esposte, la nostra raccomandazione è di utilizzare l'accesso server-to-server alle API REST di Azure Maps, dove questa chiave può essere memorizzata in modo sicuro.
Tipo:
apiKey
In:
header
SAS Token
Questo è un token di firma di accesso condiviso creato dall'operazione List SAS sulla risorsa Azure Maps tramite il piano di gestione Azure tramite Azure portale, PowerShell, CLI, Azure SDKs o API REST.
Con questo token, qualsiasi applicazione è autorizzata ad accedere tramite Azure ai controlli di accesso basati su ruoli e a un controllo fine della scadenza, del tasso e delle regioni di utilizzo per il particolare token. 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
{
"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."
}
}
Definizioni
| Nome | Descrizione |
|---|---|
|
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
|
Error |
Dettagli dell'errore. |
|
Features |
Specifica il tipo di |
|
Maps |
Dettagli dell'errore. |
|
Maps |
Risposta comune all'errore per le API di Azure Maps per restituire dettagli di errore per operazioni fallite. |
|
Maps |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
|
Route |
Specifica le istruzioni di guida e le proprietà aggiuntive per ogni punto di manovra nel percorso Gamba. |
|
Route |
Proprietà della matrice di route. |
|
Route |
Risultato dell'elemento Matrice di route |
|
Route |
Riepilogo per la richiesta della matrice di route |
|
Route |
Tipo di operazione asincrona |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
| Nome | Tipo | Descrizione |
|---|---|---|
| info |
object |
Informazioni aggiuntive. |
| type |
string |
Tipo di informazioni aggiuntive. |
ErrorDetail
Dettagli dell'errore.
| Nome | Tipo | Descrizione |
|---|---|---|
| additionalInfo |
Informazioni aggiuntive sull'errore. |
|
| code |
string |
Codice di errore. |
| details |
Dettagli dell'errore. |
|
| message |
string |
Messaggio di errore. |
| target |
string |
Destinazione dell'errore. |
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 |
MapsErrorDetail
Dettagli dell'errore.
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
string |
Uno di un set definito dal server di codici di errore. |
| details |
Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato. |
|
| innererror |
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 Azure Maps per restituire dettagli di errore per operazioni fallite.
| Nome | Tipo | Descrizione |
|---|---|---|
| error |
Dettagli dell'errore. |
MapsInnerError
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
string |
Codice di errore. |
| innererror |
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 |
object |
L'oggetto geometry è Null |
| kind |
string:
Route |
Tipo di operazione asincrona |
| properties |
Proprietà della matrice di route. |
|
| type |
Specifica il tipo di |
RouteMatrixFeatureProperties
Proprietà della matrice di route.
| Nome | Tipo | Descrizione |
|---|---|---|
| matrix |
Matrice dei risultati della route. |
|
| summary |
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 |
| departureAt |
string (date-time) |
L'ora di partenza stimata, che tiene conto delle condizioni del traffico, viene formattata come valore |
| 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 |
| error |
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. |