Route - Get Route Operations Result

Uzyskaj wynik operacji asynchronicznej według identyfikatora operacji.

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

Parametry identyfikatora URI

Nazwisko W Wymagane Typ Opis
endpoint
path True

string (uri)

Nazwa hosta usługi Azure Maps. Użyj https://atlas.microsoft.com do Azure chmury publicznej. Aby skupić się na konkretnej Azure Maps geografii lub chmurze suwerennej, zobacz Azure Maps zakres geograficzny.

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}$

System generuje unikalny identyfikator dla operacji asynchronicznej po jej przesłaniu.

api-version
query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwisko Wymagane Typ Opis
x-ms-client-id

string

Wskazuje konto przeznaczone do użycia z modelem bezpieczeństwa Microsoft Entra ID. Ten unikalny identyfikator konta Azure Maps można uzyskać z API Azure Maps Account API na płaszczyźnie zarządzania. Więcej informacji na temat korzystania z Microsoft Entra ID zabezpieczeń w Azure Maps można znaleźć w Manage authentication in Azure Maps.

Accept-Language

string

Język, w którym powinny być zwracane wyniki routingu.

Więcej informacji można znaleźć w Wsparcie lokalizacji w Azure Maps.

Odpowiedzi

Nazwisko Typ Opis
200 OK RouteOperationResponse:

RouteMatrixAsyncResponse

Żądanie zakończyło się pomyślnie.

404 Not Found

MapsErrorResponse

Serwer nie może odnaleźć żądanego zasobu.

Other Status Codes

MapsErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

AadToken

Są to przepływy Microsoft Entra OAuth 2.0. W połączeniu z Azure zarządzaniem dostępem opartym na rolach może być używany do kontroli dostępu do Azure Maps API REST. Kontrola dostępu oparta na rolach Azure służy do wyznaczania dostępu do jednego lub więcej kont zasobów lub podzasobów Azure Maps. 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.

Note

  • Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id w celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania usługami Maps.
  • Authorization URL jest specyficzna dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikalne adresy URL autoryzacji oraz konfiguracje Microsoft Entra ID.
  • Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana na podstawie 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.
  • Użycie zestawu Web SDK usługi Azure Maps umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.
  • Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Platforma tożsamości Microsoft overview.

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

Zakresy

Nazwisko Opis
https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenie konta usługi Azure Maps w witrynie Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może służyć jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie poufnych aplikacji klienckich podejście do uzyskiwania dostępu do interfejsów API REST usługi Azure Maps, aby klucz mógł 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

Retrieve the async matrix result

Przykładowe żądanie

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

Przykładowa odpowiedź

{
  "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
    }
  }
}
{
  "error": {
    "code": "NotFound",
    "message": "Not Found: the requested resource could not be found."
  }
}

Definicje

Nazwisko Opis
CommonErrorDetail

Szczegóły błędu.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

FeaturesItemTypeEnum

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

MapsErrorDetail

Szczegóły błędu.

MapsErrorResponse

Typowa odpowiedź na błędy dla API Azure Maps do zwracania szczegółów błędu dla nieudanych operacji.

MapsInnerError

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

RouteMatrixAsyncResponse

Określa instrukcje jazdy i dodatkowe właściwości dla każdego punktu manewru na odcinku trasy.

RouteMatrixFeatureProperties

Właściwości macierzy tras.

RouteMatrixItemResult

Wynik elementu macierzy tras

RouteMatrixSummary

Podsumowanie żądania macierzy tras

RouteOperationKindEnum

Rodzaj operacji asynchronicznej

CommonErrorDetail

Szczegóły błędu.

Nazwisko Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

CommonErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwisko Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

FeaturesItemTypeEnum

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

Wartość Opis
Feature

Określa typ obiektu funkcji GeoJSON.

MapsErrorDetail

Szczegóły błędu.

Nazwisko Typ Opis
code

string

Jeden z zdefiniowanych przez serwer zestaw kodów błędów.

details

MapsErrorDetail[]

Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.

innererror

MapsInnerError

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

message

string

Czytelna dla człowieka reprezentacja błędu.

target

string

Element docelowy błędu.

MapsErrorResponse

Typowa odpowiedź na błędy dla API Azure Maps do zwracania szczegółów błędu dla nieudanych operacji.

Nazwisko Typ Opis
error

MapsErrorDetail

Szczegóły błędu.

MapsInnerError

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

Nazwisko Typ Opis
code

string

Kod błędu.

innererror

MapsInnerError

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

RouteMatrixAsyncResponse

Określa instrukcje jazdy i dodatkowe właściwości dla każdego punktu manewru na odcinku trasy.

Nazwisko Typ Opis
geometry

Obiekt geometrii ma wartość null

kind string:

RouteMatrix

Rodzaj operacji asynchronicznej

properties

RouteMatrixFeatureProperties

Właściwości macierzy tras.

type

FeaturesItemTypeEnum

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

RouteMatrixFeatureProperties

Właściwości macierzy tras.

Nazwisko Typ Opis
matrix

RouteMatrixItemResult[]

Macierz wyników trasy.

summary

RouteMatrixSummary

Podsumowanie żądania macierzy tras

RouteMatrixItemResult

Wynik elementu macierzy tras

Nazwisko Typ Opis
arrivalAt

string (date-time)

Szacowany dateTime czas przybycia, który uwzględnia warunki drogowe, jest sformatowany jako wartość zdefiniowana w RFC 3339, sekcja 5.6. Będzie odwoływać się do przesunięcia strefy czasowej o jeden lub departAtarrivalAt. Jeśli nie, zostanie użyty czas UTC. Jeśli departAt lub arriveAt jest dowolne, to departureAt jest nieobecne.

departureAt

string (date-time)

Szacowany czas odjazdu, który uwzględnia warunki drogowe, jest sformatowany jako dateTime wartość zdefiniowana w RFC 3339, sekcja 5.6. Będzie odwoływać się do przesunięcia strefy czasowej o jeden lub departAtarrivalAt. Jeśli nie, zostanie użyty czas UTC. Jeśli departAt lub arriveAt ma wartość any, to departureAt jest nieobecne.

destinationIndex

integer (int32)

Indeks punktu docelowego

distanceInMeters

number (double)

Długość w metrach, właściwość

durationInSeconds

integer (int64)

Szacowany czas podróży w sekundach, który nie obejmuje opóźnień na trasie spowodowanych warunkami drogowymi.

durationTrafficInSeconds

integer (int64)

Czas potrzebny na przebycie w sekundach odpowiada aktualnym TravelDistance warunkom drogowym. Wartość ta jest podawana, jeśli traffic=live jest przekazywana, aby uwzględnić aktualne warunki ruchu.

error

CommonErrorDetail

Szczegóły błędu.

originIndex

integer (int32)

Indeks punktu początkowego

statusCode

integer (int32)

Kod stanu HTTP bieżącej komórki.

RouteMatrixSummary

Podsumowanie żądania macierzy tras

Nazwisko Typ Opis
successfulCount

integer (int32)

Liczba udanych tras w tej macierzy.

totalCount

integer (int32)

Łączna liczba tras w tej macierzy.

RouteOperationKindEnum

Rodzaj operacji asynchronicznej

Wartość Opis
RouteMatrix

Zadanie asynchroniczne macierzy tras.