Route - Get Route Operations Status

Service:: Maps

API-versie:: 2025-01-01

Verkrijg de status van een asynchrone operatie via de bewerkings-ID.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	De hostnaam van de Azure Maps-service. Gebruik `https://atlas.microsoft.com` voor de Azure publieke cloud. Om een specifieke Azure Maps geografie of een soevereine cloud te targeten, zie Azure Maps geografische reikwijdte.
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}$	Door het systeem gegenereerde unieke id voor de asynchrone bewerking nadat deze is ingediend.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	RouteOperation	De aanvraag is voltooid.
404 Not Found	MapsErrorResponse	De aangevraagde resource kan niet worden gevonden op de server.
Other Status Codes	MapsErrorResponse	Een onverwachte foutreactie.

Beveiliging

AadToken

Dit zijn de Microsoft Entra OAuth 2.0 stromen. In combinatie met Azure rolgebaseerde toegang control kan het worden gebruikt om de toegang tot Azure Maps REST-API's te controleren. Azure rolgebaseerde toegangscontroles worden gebruikt om toegang aan een of meer Azure Maps-resourceaccounts of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.

Note

Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id-header om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen uit de Maps Management API-.
De Authorization URL is specifiek voor het exemplaar van de openbare Azure-cloud. Sovereign clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties.
Het op rollen gebaseerde toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
Gebruik van de Azure Maps Web SDK maakt configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.
Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u Een Azure Maps-account maken in Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze worden uitgegeven.

Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: header

SAS Token

Dit is een shared access Signature-token dat wordt gemaakt op basis van de bewerking List SAS op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Retrieve the async matrix operation status

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

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

Statuscode:: 404

{
  "error": {
    "code": "NotFound",
    "message": "Not Found: the requested resource could not be found."
  }
}

Definities

Name	Description
CommonErrorDetail	De foutdetails.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
MapsErrorDetail	De foutdetails.
MapsErrorResponse	Veelvoorkomende foutrespons voor Azure Maps API's om foutdetails terug te geven bij mislukte operaties.
MapsInnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
RouteOperation	Dit object wordt teruggestuurd vanaf een succesvol Get Operation-verzoek.
RouteOperationKindEnum	Type asynchrone bewerking
RouteOperationResult	Het resultaat van asynchrone werking
StatusEnum	Huidige status van de asynchrone operatie.

CommonErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	CommonErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

MapsErrorDetail

Object

De foutdetails.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	MapsErrorDetail[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	MapsInnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

MapsErrorResponse

Object

Veelvoorkomende foutrespons voor Azure Maps API's om foutdetails terug te geven bij mislukte operaties.

Name	Type	Description
error	MapsErrorDetail	De foutdetails.

MapsInnerError

Object

Een object met meer specifieke informatie dan het huidige object over de fout.

Name	Type	Description
code	string	De foutcode.
innererror	MapsInnerError	Een object met meer specifieke informatie dan het huidige object over de fout.

RouteOperation

Object

Dit object wordt teruggestuurd vanaf een succesvol Get Operation-verzoek.

Name	Type	Description
createdAt	string (date-time)	Tijdstempel wanneer de operatie werd aangemaakt.
error	CommonErrorDetail	De foutdetails.
id	string	Unieke identificatie voor de asynchrone operatie.
kind	RouteOperationKindEnum	Type asynchrone bewerking
lastActionAt	string (date-time)	Tijdstempel wanneer de bedrijfsstatus werd bijgewerkt.
result	RouteOperationResult	Het resultaat van asynchrone werking
status	StatusEnum	Huidige status van de asynchrone operatie.

RouteOperationKindEnum

Opsomming

Type asynchrone bewerking

Waarde	Description
RouteMatrix	Routematrix asynchrone taak.

RouteOperationResult

Object

Het resultaat van asynchrone werking

Name	Type	Description
resultUrl	string (uri)	URL om het resultaat van de asynchrone operatie te verkrijgen

StatusEnum

Opsomming

Huidige status van de asynchrone operatie.

Waarde	Description
NotStarted	De operatie is nog niet begonnen.
Running	De operatie loopt.
Completed	De bewerking is met succes voltooid.
Failed	De bewerking is mislukt.