Route - Get Route Operations Result

Dienst:: Maps

API-Version:: 2025-01-01

Rufen Sie das Ergebnis eines asynchronen Vorgangs anhand der Vorgangs-ID ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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}$	Der vom System generierte eindeutige Bezeichner für den asynchronen Vorgang, nachdem er übermittelt wurde.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt das Konto an, das für die Nutzung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Diese eindeutige ID für das Azure Maps-Konto kann aus der Azure Maps Management-Plane-Konto-API abgerufen werden. Weitere Informationen zur Nutzung Microsoft Entra ID Sicherheit in Azure Maps finden Sie unter Authentifizierung verwalten in Azure Maps.
Accept-Language		string	Sprache, in der Routingergebnisse zurückgegeben werden sollen. Weitere Informationen finden Sie unter Localization Support in Azure Maps.

Name

Erforderlich

Typ

Beschreibung

x-ms-client-id

string

Gibt das Konto an, das für die Nutzung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Diese eindeutige ID für das Azure Maps-Konto kann aus der Azure Maps Management-Plane-Konto-API abgerufen werden. Weitere Informationen zur Nutzung Microsoft Entra ID Sicherheit in Azure Maps finden Sie unter Authentifizierung verwalten in Azure Maps.

Accept-Language

string

Sprache, in der Routingergebnisse zurückgegeben werden sollen.

Weitere Informationen finden Sie unter Localization Support in Azure Maps.

Antworten

Name	Typ	Beschreibung
200 OK	RouteOperationResponse: RouteMatrixAsyncResponse	Die Anforderung ist erfolgreich.
404 Not Found	MapsErrorResponse	Der Server kann die angeforderte Ressource nicht finden.
Other Status Codes	MapsErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

AadToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. In Kombination mit Azure rollenbasierten Zugriffs Steuerung kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Azure-rollenbasierte Zugriffskontrollen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jeder Benutzer, jede Gruppe oder jeder Service-Principal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle erhalten, die aus einer oder mehreren Berechtigungen besteht, REST-APIs zu Azure Maps.\n\nUm Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepte anzusehen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zur Modellierung von Anwendungen über Objekte, die Zugriff auf spezifische APIs und Scopes ermöglichen.\n\n#### Anmerkungen\n* Diese Sicherheitsdefinition re die Verwendung des x-ms-client-id Headers, um anzuzeigen, auf welche Azure Maps Ressource die Anwendung Zugriff bittet. Dies kann über die Maps Management API erworben werden.\n* \nDas Authorization URL ist spezifisch für die Azure Public Cloud-Instanz. Souveräne Clouds verfügen über einzigartige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen. \n* \nDie Azure rollenbasierte Zugriffskontrolle wird von der Azure Managementebene über Azure Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.\n* \nNutzung der Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.\n* Für weitere Informationen zu Microsoft Identity Platform siehe Microsoft Identity Platform Übersicht.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

subscription-key

Dies ist ein gemeinsamer Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps Konto im Azure Portal oder mit PowerShell, CLI, Azure SDKs oder REST API erstellen.\n\n Mit diesem Schlüssel kann jede Anwendung auf alle REST-APIs zugreifen. Mit anderen Worten: Dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgegeben werden.\n\n Für öffentlich zugängliche Anwendungen empfehlen wir, den Ansatz confidential Client Applications zu verwenden, um auf Azure Maps REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: header

SAS Token

Dies ist ein Shared-Access-Signaturtoken, das aus der List SAS-Operation auf der Azure Maps Ressource über die Azure Managementebene über Azure Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.\n\n Mit diesem Token ist jede Anwendung autorisiert, mit Azure rollenbasierte Zugriffskontrollen und feine Kontrolle über Ablauf, Rate und Nutzungsregion des jeweiligen Tokens. Mit anderen Worten: Der SAS-Token kann verwendet werden, um Anwendungen die Zugriffskontrolle auf sicherere Weise als der gemeinsame Schlüssel zu ermöglichen.\n\n Für öffentlich zugängliche Anwendungen empfehlen wir, eine spezielle Liste erlaubter Ursprünge auf der Map-Konto-Ressource zu konfigurieren, um Rendering-Missbrauch zu begrenzen, und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Retrieve the async matrix result

Beispielanforderung

HTTP

GET {endpoint}/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2025-01-01

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 404

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

Definitionen

Name	Beschreibung
CommonErrorDetail	Das Fehlerdetails.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
FeaturesItemTypeEnum	Gibt den `GeoJSON` Typ an. Der einzige unterstützte Objekttyp ist Feature. Weitere Informationen finden Sie unter RFC 7946.
MapsErrorDetail	Das Fehlerdetails.
MapsErrorResponse	Übliche Fehlerantwort für Azure Maps-APIs zur Rückgabe von Fehlerdetails bei fehlgeschlagenen Operationen.
MapsInnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
RouteMatrixAsyncResponse	Gibt die Fahranweisungen und zusätzlichen Eigenschaften für jeden Manöverpunkt im Streckenabschnitt an.
RouteMatrixFeatureProperties	Route Matrix-Eigenschaften.
RouteMatrixItemResult	Ergebnis des Routingmatrixelements
RouteMatrixSummary	Zusammenfassung für die Routenmatrixanforderung
RouteOperationKindEnum	Typ des asynchronen Vorgangs

CommonErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	CommonErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

FeaturesItemTypeEnum

Enumeration

Gibt den GeoJSON Typ an. Der einzige unterstützte Objekttyp ist Feature. Weitere Informationen finden Sie unter RFC 7946.

Wert	Beschreibung
Feature	Gibt den `GeoJSON` Featureobjekttyp an.

MapsErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	MapsErrorDetail[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	MapsInnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

MapsErrorResponse

Objekt

Übliche Fehlerantwort für Azure Maps-APIs zur Rückgabe von Fehlerdetails bei fehlgeschlagenen Operationen.

Name	Typ	Beschreibung
error	MapsErrorDetail	Das Fehlerdetails.

MapsInnerError

Objekt

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
innererror	MapsInnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

RouteMatrixAsyncResponse

Objekt

Gibt die Fahranweisungen und zusätzlichen Eigenschaften für jeden Manöverpunkt im Streckenabschnitt an.

Name	Typ	Beschreibung
geometry		Das Geometry-Objekt ist null.
kind	string: RouteMatrix	Typ des asynchronen Vorgangs
properties	RouteMatrixFeatureProperties	Route Matrix-Eigenschaften.
type	FeaturesItemTypeEnum	Gibt den `GeoJSON` Typ an. Der einzige unterstützte Objekttyp ist Feature. Weitere Informationen finden Sie unter RFC 7946.

RouteMatrixFeatureProperties

Objekt

Route Matrix-Eigenschaften.

Name	Typ	Beschreibung
matrix	RouteMatrixItemResult[]	Die Matrix der Routenergebnisse.
summary	RouteMatrixSummary	Zusammenfassung für die Routenmatrixanforderung

RouteMatrixItemResult

Objekt

Ergebnis des Routingmatrixelements

Name	Typ	Beschreibung
arrivalAt	string (date-time)	Die geschätzte Ankunftszeit, die die Verkehrsbedingungen berücksichtigt, wird als `dateTime` Wert formatiert, der durch RFC 3339, Abschnitt 5.6definiert ist. Es wird auf den Zeitzonenoffset entweder durch `departAt` oder `arrivalAt`verwiesen. Wenn nicht, wird die UTC-Zeit verwendet. Wenn departureAt oder arriveAt irgendein ist, dann ist departureAt nicht vorhanden.
departureAt	string (date-time)	Die geschätzte Abfahrtszeit, die die Verkehrsbedingungen berücksichtigt, wird als `dateTime` Wert formatiert, der durch RFC 3339, Abschnitt 5.6definiert ist. Es wird auf den Zeitzonenoffset entweder durch `departAt` oder `arrivalAt`verwiesen. Wenn nicht, wird die UTC-Zeit verwendet. Wenn departAt oder arriveAt ist `any`, dann ist departureAt nicht vorhanden.
destinationIndex	integer (int32)	Index des Zielpunkts
distanceInMeters	number (double)	Length In Meter-Eigenschaft
durationInSeconds	integer (int64)	Geschätzte Fahrzeit in Sekunden, die aufgrund von Verkehrsbedingungen keine Verzögerungen auf der Route enthält.
durationTrafficInSeconds	integer (int64)	Die Zeit, die es in Sekunden dauert, um eine entsprechende `TravelDistance` mit aktuellen Verkehrsbedingungen zu reisen. Dieser Wert wird bereitgestellt, wenn `optimizeRoute` Überlegungen zum Datenverkehr enthält.
error	CommonErrorDetail	Das Fehlerdetails.
originIndex	integer (int32)	Index des Ursprungspunkts
statusCode	integer (int32)	Der HTTP-Statuscode der aktuellen Zelle.

RouteMatrixSummary

Objekt

Zusammenfassung für die Routenmatrixanforderung

Name	Typ	Beschreibung
successfulCount	integer (int32)	Anzahl der erfolgreichen Routen in dieser Matrix.
totalCount	integer (int32)	Gesamtanzahl der Routen innerhalb dieser Matrix.

RouteOperationKindEnum

Enumeration

Typ des asynchronen Vorgangs

Wert	Beschreibung
RouteMatrix	Asynchroner Auftrag für die Routenmatrix.