Route - Post Route Matrix

Die Route Matrix-API ist eine HTTP-POST Anforderung, die die Berechnung einer Matrix von Routenzusammenfassungen für eine Reihe von Routen ermöglicht, die durch Ursprungs- und Zielspeicherorte mithilfe einer Synchronisierungsanforderung definiert sind. Für jeden bestimmten Ursprung berechnet der Dienst die Kosten des Routings von diesem Ursprung an jedes bestimmte Ziel. Der Satz von Ursprüngen und der Zielsatz kann als Spalten- und Zeilenüberschriften einer Tabelle betrachtet werden, und jede Zelle in der Tabelle enthält die Kosten für das Routing vom Ursprung an das Ziel für diese Zelle. Routenmatrizen können für Fahr-, Fuß- und Lkw-Routen berechnet werden. Beispielsweise hat ein Lebensmittellieferunternehmen 20 Fahrer und sie müssen den nächstgelegenen Fahrer finden, um die Lieferung aus dem Restaurant zu abholen. Um diesen Anwendungsfall zu lösen, können sie die Route Matrix-API aufrufen und die Reisekosten verwenden, um die Fahrer nach ihrer tatsächlichen Entfernung oder Zeit vom Restaurant zu sortieren.

Route Matrices werden in verschiedenen Arten von Anwendungen verwendet, die am häufigsten zur Lösung des Problems "Traveling Salesman" (TSP) und des Fahrzeugroutingproblems (Vehicle Routing Problem, VRP) verwendet werden. Für jedes Ursprungszielpaar in der Matrix werden die Fahrzeit und die Entfernung zurückgegeben. Mit den berechneten Kosten können Sie ermitteln, welche detaillierten Routen mithilfe der Routenbeschreibungs-API berechnet werden sollen.

Die maximale Größe einer Matrix für die Synchronisierungsanforderung ist 2500 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele).

Synchrone Routenmatrixanforderung übermitteln

Wenn Für Ihr Szenario synchrone Anforderungen erforderlich sind und die maximale Größe der Matrix kleiner oder gleich 2500 ist, sollten Sie synchrone Anforderungen stellen. Die maximale Größe einer Matrix für diese API ist 2500 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Bei dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 50x50, 60x40, 90x20 (es muss nicht quadratisch sein).

API-Einschränkungen

Die synchrone Verarbeitung der Matrix eignet sich am besten für schnelle, kleine Matrizen der Routenberechnung. Verwenden Sie den asynchronen Endpunkt, um größere Matrizen und schwere Routenberechnungen zu berechnen. Die folgende Einschränkung gilt für die synchronen Anforderungen. Wenn keine der Zeilen in der folgenden Tabelle mit den Parametern der Anforderung übereinstimmt, erfüllt die Anforderung nicht die Anforderungen und wird nicht verarbeitet.

Beispiele

• Anforderung von 10x20-Matrix mit traffic=live: Diese Anforderung wird mit einem Begrenzungsfeldgrenzwert verarbeitet, da sie einem Grenzwert von bis zu 200 entspricht, der Begrenzungsfeldeinschränkungen umfasst.

• Anforderung von 10x20-Matrix mit Standardparametern (traffic=historical): Diese Anforderung wird ohne Begrenzung des Feldlimits verarbeitet, da sie einem Grenzwert von bis zu 2500 entspricht, was keine Begrenzungseinschränkungen angibt.

POST https://atlas.microsoft.com/route/matrix?api-version=2025-01-01

URI-Parameter

Anforderungsheader

Media Types: "application/geo+json"

Anforderungstext

Media Types: "application/geo+json"

Antworten

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.

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

Bereiche

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

Successfully retrieve a route matrix with additional parameters in the body

POST https://atlas.microsoft.com/route/matrix?api-version=2025-01-01

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiPoint",
        "coordinates": [
          [
            9.15049,
            45.458545
          ],
          [
            11.050541,
            45.403337
          ]
        ]
      },
      "properties": {
        "pointType": "origins"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiPoint",
        "coordinates": [
          [
            11.499931,
            48.149853
          ],
          [
            14.538226,
            50.033688
          ]
        ]
      },
      "properties": {
        "pointType": "destinations"
      }
    }
  ],
  "departAt": "2022-12-19T16:39:57+01:00",
  "optimizeRoute": "fastest",
  "traffic": "historical",
  "travelMode": "truck",
  "avoid": [
    "unpavedRoads"
  ]
}

{
  "type": "Feature",
  "geometry": null,
  "properties": {
    "summary": {
      "totalCount": 4,
      "successfulCount": 4
    },
    "matrix": [
      {
        "statusCode": 200,
        "originIndex": 0,
        "destinationIndex": 0,
        "durationTrafficInSeconds": 21007,
        "durationInSeconds": 21007,
        "distanceInMeters": 492466,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-19T22:30:03+01:00"
      },
      {
        "statusCode": 200,
        "originIndex": 0,
        "destinationIndex": 1,
        "durationTrafficInSeconds": 33623,
        "durationInSeconds": 33623,
        "distanceInMeters": 877028,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-20T02:00:19+01:00"
      },
      {
        "statusCode": 200,
        "originIndex": 1,
        "destinationIndex": 0,
        "durationTrafficInSeconds": 19520,
        "durationInSeconds": 19520,
        "distanceInMeters": 427769,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-19T22:05:16+01:00"
      },
      {
        "statusCode": 200,
        "originIndex": 1,
        "destinationIndex": 1,
        "durationTrafficInSeconds": 32070,
        "durationInSeconds": 32070,
        "distanceInMeters": 836080,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-20T01:34:27+01:00"
      }
    ]
  }
}

Definitionen

AdrTunnelRestrictionCodeEnum

Der ADR-Tunneleinschränkungscode. ADR ist ein europäisches Abkommen über die internationale Beförderung gefährlicher Güter auf der Straße. Der ADR-Tunneleinschränkungscode wird verwendet, um zu bestimmen, ob ein Fahrzeug durch einen Tunnel mit Einschränkungen bei der Beförderung gefährlicher Güter durchfahren darf.

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.

FeatureTypeEnum

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

GeoJsonMultiPoint

Ein gültiger GeoJSON MultiPoint Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.

InputRouteMatrixFeaturesItem

Gibt die Eingabeursprung- und Zielpunkte sowie zusätzliche Eigenschaften für das GeoJSON MultiPoint-Featureobjekt an. Weitere Informationen finden Sie in RFC 7946 .

InputRouteMatrixProperties

Gibt das Eigenschaftenobjekt für die Eingabematrix an.

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.

RouteMatrixAvoidEnum

Gibt Einschränkungen an, die bei der Ermittlung der Route berücksichtigt werden sollen. Vermeiden Sie die Unterstützung mehrerer Werte in einer Anforderung und wird nur für den Fahr- und Lkw-Reisemodus unterstützt.

RouteMatrixFeatureProperties

Route Matrix-Eigenschaften.

RouteMatrixItemResult

Ergebnis des Routingmatrixelements

RouteMatrixOptimizeRouteEnum

Gibt den Parameter an, der zum Optimieren der Route verwendet werden soll. Wenn nicht definiert, ist der Standardwert "schnellste" und gibt die Route zurück, um die Fahrzeit zu minimieren.

Beispiel: "optimizeRoute":"am schnellsten"

RouteMatrixRequest

Dient zum Abrufen einer Routenmatrix, die die Fahrzeit und Entfernung für alle möglichen Paare in einer Liste der Ursprünge und des Ziels anzeigt. GeoJSON Featureobjekt und zusätzliche Eigenschaften. Weitere Informationen finden Sie in RFC 7946 .

RouteMatrixResponse

Dieses Objekt wird von einem erfolgreichen Aufruf zurückgegeben.

RouteMatrixSummary

Zusammenfassung für die Routenmatrixanforderung

RouteMatrixTrafficEnum

Gibt an, wie Datenverkehr für die Berechnung von Routen berücksichtigt wird.

Standardwert: historical

RouteMatrixTravelModeEnum

Gibt das Reiseprofil an, das beim Berechnen der Matrix berücksichtigt werden soll. Wenn nicht angegeben, lautet der Standardwert "Driving".

Beispiel: "travelMode":"fahren"

RouteMatrixTypeEnum

Gibt den Ursprung MultiPoint-Typ und den Ziel-MultiPoint-Typ für die Eingabematrix an.

RouteMatrixVehicleSpec

Gibt die Fahrzeugattribute wie Fahrzeughöhe, Gewicht, Höchstgeschwindigkeit, Frachttyp usw. an, die bei der Berechnung der Routenmatrix berücksichtigt werden sollen. Dies trägt dazu bei, niedrige Brückenabstände, Straßeneinschränkungen, schwierige Rechtsdrehungen zu vermeiden, um die optimierte Route basierend auf den Fahrzeugspezifikationen bereitzustellen. Fahrzeugattribute werden innerhalb der Eigenschaft "vehicleSpec" angegeben.

RouteOperationKindEnum

Typ des asynchronen Vorgangs

VehicleLoadTypeEnum

Ladungstypen, die als gefährliche Stoffe eingestuft und von einigen Straßen eingeschränkt werden können. Verfügbare vehicleLoadType-Werte sind US Hazmat Klassen 1 bis 9 sowie generische Klassifizierungen für die Verwendung in anderen Ländern. Werte, die mit USHazmat beginnen, gelten für US-Routing, während andereHazmat für alle anderen Länder verwendet werden sollten. vehicleLoadType unterstützt mehrere Werte in einer Anforderung.