Dela via


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

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

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

RouteOperation

Begäran har slutförts.

404 Not Found

MapsErrorResponse

Servern kan inte hitta den begärda resursen.

Other Status Codes

MapsErrorResponse

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. Varje användare, grupp eller tjänstehuvudperson kan beviljas åtkomst via en inbyggd roll eller en anpassad roll bestående av en eller flera behörigheter för att Azure Maps REST-API:er.\n\nFör att implementera scenarier rekommenderar vi att man tittar på autentiseringskoncept. Sammanfattningsvis erbjuder denna säkerhetsdefinition en lösning för modellering av applikationer via objekt som kan åtkomstkontroll på specifika API:er och scopes.\n\n#### Anteckningar\n* Denna säkerhetsdefinition kräver användning av x-ms-client-id-headern för att ange vilken Azure Maps resurs applikationen begär åtkomst till. Detta kan hämtas från Maps management API.\n* \nAuthorization URL är specifik för den Azure publika molninstansen. Suveräna moln har unika auktoriserings-URL:er och Microsoft Entra ID-konfigurationer. \n* \nDen Azure rollbaserade åtkomstkontrollen konfigureras från Azure hanteringsplanet via Azure portal, PowerShell, CLI, Azure-SDK:er eller REST API:er.\n* \nAnvändning av Azure Maps Web SDK möjliggör konfigurationsbaserad installation av en applikation för flera användningsområden.\n* För mer information om Microsofts identitetsplattform, se Microsofts identitetsplattform översikt.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
https://atlas.microsoft.com/.default

subscription-key

Detta är en delad nyckel som provisioneras när du Skapa ett Azure Maps-konto i Azure-portalen eller med PowerShell, CLI, Azure-SDK:er eller REST API.\n\n Med denna nyckel kan vilken applikation som helst komma åt alla REST API:er. Med andra ord kan denna nyckel användas som en huvudnyckel i det konto där de utfärdas.\n\n För offentligt exponerade applikationer rekommenderar vi att använda konfidentiella klientapplikationer för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras säkert.

Typ: apiKey
I: header

SAS Token

Detta är en delad åtkomstsignaturtoken som skapas från List SAS-operationen på Azure Maps-resursen via Azure hanteringsplanet via Azure portal, PowerShell, CLI, Azure-SDK:er eller REST-API:er.\n\n Med denna token är varje applikation auktoriserad att få åtkomst med Azure rollbaserade åtkomstkontroller och finkornig kontroll till utgångsdatum, hastighet och region(er) för användning för den specifika token. Med andra ord kan SAS-token användas för att låta applikationer kontrollera åtkomsten på ett säkrare sätt än den delade nyckeln.\n\n För offentligt exponerade applikationer är vår rekommendation att konfigurera en specifik lista över tillåtna ursprung på Map-kontots resurs för att begränsa renderingsmissbruk och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Retrieve the async matrix operation status

Exempelbegäran

GET {endpoint}/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
CommonErrorDetail

Detaljerna om felet.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

MapsErrorDetail

Detaljerna om felet.

MapsErrorResponse

Vanligt felsvar för Azure Maps API:er för att returnera feldetaljer för misslyckade operationer.

MapsInnerError

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.

RouteOperationKindEnum

Typ av asynkron åtgärd

RouteOperationResult

Resultatet av asynkron operation

StatusEnum

Aktuell status för den asynkrona operationen.

CommonErrorDetail

Detaljerna om felet.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

CommonErrorDetail[]

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

MapsErrorDetail[]

En matris med information om specifika fel som ledde till det rapporterade felet.

innererror

MapsInnerError

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

MapsErrorDetail

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

MapsInnerError

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

CommonErrorDetail

Detaljerna om felet.

id

string

Unik identifierare för den asynkrona operationen.

kind

RouteOperationKindEnum

Typ av asynkron åtgärd

lastActionAt

string (date-time)

Tidsstämpel när driftstatusen uppdaterades.

result

RouteOperationResult

Resultatet av asynkron operation

status

StatusEnum

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.