Freigeben über


Route - Get Route Operations Result

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

GET https://atlas.microsoft.com/route/operations/{id}/result?api-version=2025-01-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
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}$

Vom System generierter eindeutiger Bezeichner für den asynchronen Vorgang, nachdem er übermittelt wurde.

api-version
query True

string

Versionsnummer der Azure Maps-API.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-id

string

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

Accept-Language

string

Sprache, in der Routingergebnisse zurückgegeben werden sollen.

Weitere Informationen finden Sie unter Lokalisierungsunterstützung in Azure Maps.

Antworten

Name Typ Beschreibung
200 OK RouteOperationResponse:

RouteMatrixAsyncResponse

OKAY

404 Not Found

MapsErrorResponse

Das Ergebnis der Einsatzressource wurde nicht gefunden.

Header

x-ms-error-code: string

Other Status Codes

MapsErrorResponse

Ein unerwarteter Fehler ist aufgetreten.

Header

x-ms-error-code: string

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.

Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.

Hinweis

  • Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id-Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Karten-Verwaltungs-APIerworben werden.
  • Die Authorization URL ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen.
  • Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
  • Die Verwendung des Azure Maps Web SDK ermöglicht das konfigurationsbasierte Einrichten einer Anwendung für mehrere Anwendungsfälle.
  • Weitere Informationen zur Microsoft Identity Platform finden Sie unter Übersicht über die Microsoft Identity Platform.

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

Bereiche

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

subscription-key

Dies ist ein gemeinsam genutzter Schlüssel, der beim Erstellen einer Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird.

Mit diesem Schlüssel ist jede Anwendung berechtigt, auf alle REST-APIs zuzugreifen. Mit anderen Worten, diese können derzeit als Hauptschlüssel für das Konto behandelt werden, für das sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, den Server-zu-Server-Zugriff von Azure Maps-REST-APIs zu verwenden, bei denen dieser Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: header

SAS Token

Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und feinkörniger Kontrolle auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token autorisiert. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen das Steuern des Zugriffs auf eine sicherere Weise zu ermöglichen als der freigegebene Schlüssel.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge auf der Zuordnungskontoressource zu konfigurieren,, um das Rendern von Missbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Retrieve the async matrix result

Beispielanforderung

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

Beispiel für eine Antwort

{
  "kind": "RouteMatrix",
  "type": "Feature",
  "geometry": null,
  "properties": {
    "summary": {
      "totalCount": 4,
      "successfulCount": 2
    },
    "matrix": [
      {
        "statusCode": 200,
        "originIndex": 0,
        "destinationIndex": 0,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-20T00:21:14+01:00",
        "distanceInMeters": 573064,
        "durationInSeconds": 27677,
        "durationTrafficInSeconds": 27677
      },
      {
        "statusCode": 400,
        "originIndex": 0,
        "destinationIndex": 1,
        "error": {
          "code": "OUT_OF_REGION",
          "message": "Input coordinates out of region"
        }
      },
      {
        "statusCode": 200,
        "originIndex": 1,
        "destinationIndex": 0,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-19T22:19:10+01:00",
        "distanceInMeters": 452488,
        "durationInSeconds": 20353,
        "durationTrafficInSeconds": 20353
      },
      {
        "statusCode": 400,
        "originIndex": 1,
        "destinationIndex": 1,
        "error": {
          "code": "OUT_OF_REGION",
          "message": "Input coordinates out of region"
        }
      }
    ]
  }
}
{
  "error": {
    "code": "NotFound",
    "message": "Not Found: the requested resource could not be found."
  }
}

Definitionen

Name Beschreibung
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

FeaturesItemTypeEnum

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

MapsErrorDetail

Das Fehlerdetails.

MapsErrorResponse

Häufige Fehlerantwort für Azure Maps-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben.

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

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

FeaturesItemTypeEnum

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

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 normal lesbare Darstellung des Fehlers.

target

string

Das Ziel des Fehlers.

MapsErrorResponse

Häufige Fehlerantwort für Azure Maps-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben.

Name Typ Beschreibung
error

MapsErrorDetail

Das Fehlerdetails.

MapsInnerError

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

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

Name Typ Beschreibung
geometry

object

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

Route Matrix-Eigenschaften.

Name Typ Beschreibung
matrix

RouteMatrixItemResult[]

Die Matrix der Routenergebnisse.

summary

RouteMatrixSummary

Zusammenfassung für die Routenmatrixanforderung

RouteMatrixItemResult

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 arrivalAtverwiesen. 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 arrivalAtverwiesen. 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

ErrorDetail

Das Fehlerdetails.

originIndex

integer (int32)

Index des Ursprungspunkts

statusCode

integer (int32)

Der HTTP-Statuscode der aktuellen Zelle.

RouteMatrixSummary

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

Typ des asynchronen Vorgangs

Wert Beschreibung
RouteMatrix

Asynchroner Auftrag für die Routenmatrix.