Route - Get Route Operations Status
Få status för en asynkron operation via dess operations-ID.
GET {endpoint}/route/operations/{id}?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. |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK |
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 operation status
Exempelbegäran
GET https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557?api-version=2025-01-01
Exempelsvar
{
"createdAt": "2023-01-01T00:00:00Z",
"kind": "RouteMatrix",
"lastActionAt": "2023-01-01T00:05:00Z",
"result": {
"resultUrl": "https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2025-01-01"
},
"status": "Completed"
}
{
"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. |
|
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 |
Detta objekt returneras från en lyckad Get Operation-förfrågan. |
|
Route |
Typ av asynkron åtgärd |
|
Route |
Resultatet av asynkron operation |
|
Status |
Aktuell status för den asynkrona operationen. |
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. |
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. |
RouteOperation
Detta objekt returneras från en lyckad Get Operation-förfrågan.
| Name | Typ | Description |
|---|---|---|
| createdAt |
string (date-time) |
Tidsstämpel när operationen skapades. |
| error |
Detaljerna om felet. |
|
| id |
string |
Unik identifierare för den asynkrona operationen. |
| kind |
Typ av asynkron åtgärd |
|
| lastActionAt |
string (date-time) |
Tidsstämpel när driftstatusen uppdaterades. |
| result |
Resultatet av asynkron operation |
|
| status |
Aktuell status för den asynkrona operationen. |
RouteOperationKindEnum
Typ av asynkron åtgärd
| Värde | Description |
|---|---|
| RouteMatrix |
Routningsmatrisens asynkrona jobb. |
RouteOperationResult
Resultatet av asynkron operation
| Name | Typ | Description |
|---|---|---|
| resultUrl |
string (uri) |
URL för att hämta resultatet av asynkron operation |
StatusEnum
Aktuell status för den asynkrona operationen.
| Värde | Description |
|---|---|
| NotStarted |
Operationen har ännu inte påbörjats. |
| Running |
Operationen pågår. |
| Completed |
Åtgärden har slutförts. |
| Failed |
Åtgärden misslyckades. |