Route - Get Route Operations Result
Hämta resultatet av en asynkron åtgärd med dess åtgärds-ID.
GET {endpoint}/route/operations/{id}/result?api-version=2025-01-01
URI-parametrar
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Azure Maps-tjänstens värdnamn. Använd |
|
id
|
path | True |
string minLength: 36maxLength: 36 pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Systemgenererad unik identifierare för den asynkrona åtgärden efter att den har skickats. |
|
api-version
|
query | True |
string minLength: 1 |
Den API-version som ska användas för den här åtgärden. |
Begärandehuvud
| Name | Obligatorisk | Typ | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Anger vilket konto som är avsett för användning med Microsoft Entra ID-säkerhetsmodellen. Detta unika ID för Azure Maps-kontot kan erhållas från Azure Maps Management Plane Account API. För mer information om hur man använder Microsoft Entra ID säkerhet i Azure Maps, se Hantera autentisering i Azure Maps. |
|
| Accept-Language |
string |
Språk där routningsresultat ska returneras. För mer information, se Lokaliseringsstöd i Azure Maps. |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK | RouteOperationResponse: |
Begäran har slutförts. |
| 404 Not Found |
Servern kan inte hitta den begärda resursen. |
|
| Other Status Codes |
Ett oväntat felsvar. |
Säkerhet
AadToken
Dessa är Microsoft Entra OAuth 2.0 flöden. När den kombineras med Azure rollbaserad åtkomst kontroll kan den användas för att kontrollera åtkomst till Azure Maps REST-API:er. Azure:s rollbaserade åtkomstkontroller används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller delresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Azure Maps REST-API:er.
För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.
Note
- Den här säkerhetsdefinitionen kräver användningen av
x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hanterings-API:et. -
Authorization URLär specifik för den offentliga Azure-molninstansen. Suveräna moln har unika auktoriserings-URL:er och Microsoft Entra ID-konfigurationer. - Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
- Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
- Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Det här är en delad nyckel som etableras när du Skapa ett Azure Maps-konto i Azure-portalen eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.
Med den här nyckeln kan alla program komma åt alla REST API:er. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de har utfärdats i.
För offentligt exponerade program rekommenderar vi att du använder konfidentiella klientprogram metod för åtkomst till Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.
Typ:
apiKey
I:
header
SAS Token
Det här är en signaturtoken för delad åtkomst som skapas från sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll till förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.
För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på Map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.
Typ:
apiKey
I:
header
Exempel
Retrieve the async matrix result
Exempelbegäran
GET https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2025-01-01
Exempelsvar
{
"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."
}
}
Definitioner
| Name | Description |
|---|---|
|
Common |
Detaljerna om felet. |
|
Error |
Ytterligare information om resurshanteringsfelet. |
|
Features |
Anger |
|
Maps |
Detaljerna om felet. |
|
Maps |
Vanligt felsvar för Azure Maps API:er för att returnera feldetaljer för misslyckade operationer. |
|
Maps |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
|
Route |
Anger körinstruktioner och ytterligare egenskaper för varje manöverpunkt i vägbenet. |
|
Route |
Egenskaper för routningsmatris. |
|
Route |
Resultat av routningsmatrisobjekt |
|
Route |
Sammanfattning av begäran om routningsmatris |
|
Route |
Typ av asynkron åtgärd |
CommonErrorDetail
Detaljerna om felet.
| Name | Typ | Description |
|---|---|---|
| additionalInfo |
Ytterligare information om felet. |
|
| code |
string |
Felkoden. |
| details |
Felinformationen. |
|
| message |
string |
Felmeddelandet. |
| target |
string |
Felmålet. |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
| Name | Typ | Description |
|---|---|---|
| info |
object |
Ytterligare information. |
| type |
string |
Ytterligare informationstyp. |
FeaturesItemTypeEnum
Anger GeoJSON typ. Den enda objekttyp som stöds är Funktion. Mer information finns i RFC 7946.
| Värde | Description |
|---|---|
| Feature |
Anger objekttypen |
MapsErrorDetail
Detaljerna om felet.
| Name | Typ | Description |
|---|---|---|
| code |
string |
En av en serverdefinierad uppsättning felkoder. |
| details |
En matris med information om specifika fel som ledde till det rapporterade felet. |
|
| innererror |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
|
| message |
string |
En mänsklig läsbar representation av felet. |
| target |
string |
Målet för felet. |
MapsErrorResponse
Vanligt felsvar för Azure Maps API:er för att returnera feldetaljer för misslyckade operationer.
| Name | Typ | Description |
|---|---|---|
| error |
Detaljerna om felet. |
MapsInnerError
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
| Name | Typ | Description |
|---|---|---|
| code |
string |
Felkoden. |
| innererror |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
RouteMatrixAsyncResponse
Anger körinstruktioner och ytterligare egenskaper för varje manöverpunkt i vägbenet.
| Name | Typ | Description |
|---|---|---|
| geometry |
Geometriobjektet är null |
|
| kind |
string:
Route |
Typ av asynkron åtgärd |
| properties |
Egenskaper för routningsmatris. |
|
| type |
Anger |
RouteMatrixFeatureProperties
Egenskaper för routningsmatris.
| Name | Typ | Description |
|---|---|---|
| matrix |
Matrisen för routningsresultat. |
|
| summary |
Sammanfattning av begäran om routningsmatris |
RouteMatrixItemResult
Resultat av routningsmatrisobjekt
| Name | Typ | Description |
|---|---|---|
| arrivalAt |
string (date-time) |
Den uppskattade ankomsttiden, som tar hänsyn till trafikvillkoren, formateras som ett |
| departureAt |
string (date-time) |
Den uppskattade avgångstiden, som tar hänsyn till trafikförhållandena, formateras som ett |
| destinationIndex |
integer (int32) |
Index för målpunkten |
| distanceInMeters |
number (double) |
Egenskapen Längd i meter |
| durationInSeconds |
integer (int64) |
Uppskattad restid i sekunder som inte inkluderar fördröjningar på vägen på grund av trafikförhållanden. |
| durationTrafficInSeconds |
integer (int64) |
Den tid det tar i sekunder att resa en motsvarande |
| error |
Detaljerna om felet. |
|
| originIndex |
integer (int32) |
Index för ursprungspunkten |
| statusCode |
integer (int32) |
HTTP-statuskoden för den aktuella cellen. |
RouteMatrixSummary
Sammanfattning av begäran om routningsmatris
| Name | Typ | Description |
|---|---|---|
| successfulCount |
integer (int32) |
Antal lyckade vägar i den här matrisen. |
| totalCount |
integer (int32) |
Totalt antal vägar i den här matrisen. |
RouteOperationKindEnum
Typ av asynkron åtgärd
| Värde | Description |
|---|---|
| RouteMatrix |
Routningsmatrisens asynkrona jobb. |