Route - Post Route Matrix Async

Interfejs API Route Matrix Async to żądanie POST HTTP, które umożliwia obliczenie macierzy podsumowań tras dla zestawu tras zdefiniowanych przez lokalizacje początkowe i docelowe przy użyciu żądania asynchronicznego (asynchronicznego). Dla każdego danego źródła usługa oblicza koszt routingu z tego źródła do każdego miejsca docelowego. Zestaw źródeł i zestaw miejsc docelowych można traktować jako nagłówki kolumn i wierszy tabeli, a każda komórka w tabeli zawiera koszty routingu z punktu początkowego do miejsca docelowego dla tej komórki. Macierze tras można obliczać dla tras samochodowych, pieszych i ciężarówek.

Macierze tras są używane w kilku różnych typach aplikacji, najczęściej do rozwiązywania problemów komiwojażera (TSP) i problemów z wyznaczaniem tras pojazdów (VRP). Dla każdej pary punkt początkowy-docelowy w macierzy zwracany jest czas podróży i odległość. Za pomocą obliczonych kosztów można określić, które szczegółowe trasy mają być obliczane przy użyciu interfejsu API Route Directions.

Maksymalny rozmiar macierzy dla żądania asynchronicznego wynosi 50000 (liczba źródeł pomnożona przez liczbę miejsc docelowych).

Prześlij żądanie asynchronicznej macierzy tras

Interfejs API asynchroniczny jest odpowiedni do przetwarzania dużych ilości stosunkowo złożonych żądań routingu. Gdy wysyłasz żądanie przy użyciu żądania asynchronicznego, domyślnie usługa zwraca kod odpowiedzi 202 wzdłuż adresu URL w operation-Location polu nagłówka odpowiedzi z punktem końcowym geografii Azure Maps "{geography}.atlas.microsoft.com. Ten adres URL powinien być okresowo sprawdzany, dopóki stan nie zmieni się na Powodzenie.

Maksymalny rozmiar macierzy dla tego interfejsu API wynosi 50000 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając na uwadze to ograniczenie, przykładami możliwych wymiarów macierzy są: 500x100, 100x100, 280x170. 100x50 (nie musi być kwadratowy).

Odpowiedzi asynchroniczne są przechowywane przez 24 godzin. Adres URL przekierowania zwraca odpowiedź 404, jeśli jest używana po upływie okresu wygaśnięcia.

POST https://atlas.microsoft.com/route/matrix:async?api-version=2025-01-01&subscription-key={subscription-key}

Oto typowa sekwencja operacji asynchronicznych:

1. Klient wysyła żądanie POST macierzy tras do usługi Azure Maps

2. Serwer odpowie jednym z następujących elementów:

   202 Accepted HTTP — żądanie macierzy tras zostało zaakceptowane.

   Error HTTP — wystąpił błąd podczas przetwarzania żądania macierzy tras. Może to być 400 Nieprawidłowe żądanie lub inny kod stanu błędu.

3. Jeśli żądanie trasy macierzy zostało pomyślnie zaakceptowane, nagłówek w odpowiedzi zawiera adres URL, operation-location aby uzyskać stan żądania. Ten identyfikator URI stanu wygląda następująco:

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

4. Klient wysyła żądanie GET na resultUrl uzyskanym w kroku 3 w celu uzyskania wyników

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

Ograniczenia interfejsu API

Asynchroniczne przetwarzanie macierzy najlepiej nadaje się do większych macierzy, które wymagają intensywnego obliczania trasy. Następujące ograniczenie ma zastosowanie do żądań asynchronicznych. Jeśli żaden z wierszy w poniższej tabeli nie jest zgodny z parametrami żądania, oznacza to, że żądanie nie spełnia wymagań i nie zostanie przetworzone.

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

Parametry identyfikatora URI

Nagłówek żądania

Media Types: "application/geo+json"

Treść żądania

Media Types: "application/geo+json"

Odpowiedzi

Zabezpieczenia

AADToken

Są to przepływy Microsoft Entra OAuth 2.0. Po połączeniu z dostępem opartym na rolach platformy Azure kontroli może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi mogą mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.

Aby zaimplementować scenariusze, zalecamy wyświetlenie koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenia zasobów usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Za pomocą tego klucza każda aplikacja jest autoryzowana do uzyskiwania dostępu do wszystkich interfejsów API REST. Innymi słowy, mogą one być obecnie traktowane jako klucze główne do konta, dla którego są wystawiane.

W przypadku publicznie uwidocznionych aplikacji naszym zaleceniem jest użycie dostępu serwer-serwer interfejsów API REST usługi Azure Maps, w których ten klucz może być bezpiecznie przechowywany.

Typ: apiKey
W: header

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji List SAS na zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.

Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej zabezpieczony niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.

Typ: apiKey
W: header

Przykłady

Submit an asynchronous request for matrix

POST https://atlas.microsoft.com/route/matrix:async?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"
  ]
}

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

Definicje

AdrTunnelRestrictionCodeEnum

Kod ograniczenia tunelu ADR. ADR to europejska umowa dotycząca międzynarodowego przewozu drogowego towarów niebezpiecznych. Kod ograniczenia tunelu ADR służy do określenia, czy pojazd może przejechać przez tunel z ograniczeniami dotyczącymi przewozu towarów niebezpiecznych.

FeaturesItemTypeEnum

Określa typ GeoJSON. Jedynym obsługiwanym typem obiektu jest Funkcja. Aby uzyskać więcej informacji, zobacz RFC 7946.

FeatureTypeEnum

Określa typ GeoJSON. Jedynym obsługiwanym typem obiektu jest FeatureCollection. Aby uzyskać więcej informacji, zobacz RFC 7946.

GeoJsonMultiPoint

Prawidłowy typ geometrii GeoJSON MultiPoint. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

InputRouteMatrixFeaturesItem

Określa wejściowe punkty początkowe i docelowe oraz dodatkowe właściwości GeoJSON obiektu elementu MultiPoint. Szczegółowe informacje można znaleźć w dokumencie RFC 7946 .

InputRouteMatrixProperties

Określa obiekt właściwości macierzy wejściowej.

MapsErrorDetail

Szczegóły błędu.

MapsErrorResponse

Typowa odpowiedź na błędy interfejsów API usługi Azure Maps w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem.

MapsInnerError

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

RouteMatrixAsyncOptimizeRouteEnum

Określa parametr, który ma być używany do optymalizacji trasy. Jeśli nie zostanie zdefiniowana, wartość domyślna to "najszybsza", która zwraca trasę w celu zminimalizowania czasu podróży.

Przykład: "optimizeRoute":"najkrótszy"

RouteMatrixAsyncRequest

Umożliwia ustawienie macierzy tras przedstawiającej czas podróży i odległość dla wszystkich możliwych par na liście punktów początkowych i docelowych. GeoJSON obiekt funkcji i dodatkowe właściwości. Szczegółowe informacje można znaleźć w dokumencie RFC 7946 .

RouteMatrixAvoidEnum

Określa ograniczenia, które powinny być uwzględniane przy obliczaniu trasy podczas wyznaczania trasy. Opcja Avoid obsługuje wiele wartości w żądaniu i jest obsługiwana tylko w przypadku trybu jazdy i jazdy ciężarówki.

RouteMatrixTrafficEnum

Określa, w jaki sposób ruch jest uwzględniany przy obliczaniu tras.

Wartość domyślna: historical

RouteMatrixTravelModeEnum

Określa profil przesuwu, który ma być brany pod uwagę przy obliczaniu macierzy. Jeśli nie zostanie określona, wartość domyślna to "jazda".

Przykład: "travelMode":"jazda"

RouteMatrixTypeEnum

Określa początkowy typ MultiPoint i docelowy typ MultiPoint dla macierzy wejściowej.

RouteMatrixVehicleSpec

Określa atrybuty pojazdu, takie jak wysokość pojazdu, masa, prędkość maksymalna, rodzaj ładunku itp., które należy wziąć pod uwagę przy obliczaniu macierzy trasy. Pomaga to uniknąć niskich prześwitów mostów, ograniczeń drogowych, trudnych skrętów w prawo, aby zapewnić zoptymalizowaną trasę w oparciu o specyfikacje pojazdu. Atrybuty pojazdu są określone we właściwości vehicleSpec.

VehicleLoadTypeEnum

Typy ładunków, które mogą być klasyfikowane jako materiały niebezpieczne i ograniczone z niektórych dróg. Dostępne wartości vehicleLoadType to amerykańskie klasy materiałów niebezpiecznych od 1 do 9 oraz klasyfikacje ogólne do użytku w innych krajach. Wartości rozpoczynające się od USHazmat dotyczą routingu w USA, podczas gdy otherHazmat powinny być używane dla wszystkich innych krajów. vehicleLoadType obsługuje wiele wartości w żądaniu.