Route - Get Route Operations Result
Uzyskaj wynik operacji asynchronicznej według identyfikatora operacji.
GET https://atlas.microsoft.com/route/operations/{id}/result?api-version=2025-01-01
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
id
|
path | True |
string minLength: 36maxLength: 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 |
Numer wersji interfejsu API usługi Azure Maps. |
Nagłówek żądania
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| x-ms-client-id |
string |
Wskazuje konto przeznaczone do użycia z modelem zabezpieczeń Microsoft Entra ID. Ten unikatowy identyfikator konta Azure Maps można uzyskać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby uzyskać więcej informacji na temat korzystania z zabezpieczeń Microsoft Entra ID w Azure Maps, zobacz Zarządzanie uwierzytelnianiem w Azure Maps. |
|
| Accept-Language |
string |
Język, w którym powinny być zwracane wyniki routingu. Aby uzyskać więcej informacji, zobacz Obsługa lokalizacji w usłudze Azure Maps. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK | RouteOperationResponse: |
OK |
| 404 Not Found |
Nie znaleziono wyniku zasobu operacji. Nagłówki x-ms-error-code: string |
|
| Other Status Codes |
Wystąpił nieoczekiwany błąd. Nagłówki x-ms-error-code: string |
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.
Uwaga / Notatka
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-idw 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 URLjest specyficzna dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów Entra firmy Microsoft. - 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 Microsoft identity platform overview.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
| Nazwa | Opis |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
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
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ź
{
"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."
}
}
Definicje
| Nazwa | Opis |
|---|---|
|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
|
Error |
Szczegóły błędu. |
|
Features |
Określa typ |
|
Maps |
Szczegóły błędu. |
|
Maps |
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. |
|
Maps |
Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie. |
|
Route |
Określa instrukcje jazdy i dodatkowe właściwości dla każdego punktu manewru na odcinku trasy. |
|
Route |
Właściwości macierzy tras. |
|
Route |
Wynik elementu macierzy tras |
|
Route |
Podsumowanie żądania macierzy tras |
|
Route |
Rodzaj operacji asynchronicznej |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
| Nazwa | Typ | Opis |
|---|---|---|
| info |
object |
Dodatkowe informacje. |
| type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
| Nazwa | Typ | Opis |
|---|---|---|
| additionalInfo |
Dodatkowe informacje o błędzie. |
|
| code |
string |
Kod błędu. |
| details |
Szczegóły błędu. |
|
| message |
string |
Komunikat o błędzie. |
| target |
string |
Element docelowy błędu. |
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 |
MapsErrorDetail
Szczegóły błędu.
| Nazwa | Typ | Opis |
|---|---|---|
| code |
string |
Jeden z zdefiniowanych przez serwer zestaw kodów błędów. |
| details |
Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu. |
|
| innererror |
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 interfejsów API usługi Azure Maps w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem.
| Nazwa | Typ | Opis |
|---|---|---|
| error |
Szczegóły błędu. |
MapsInnerError
Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
| Nazwa | Typ | Opis |
|---|---|---|
| code |
string |
Kod błędu. |
| innererror |
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.
| Nazwa | Typ | Opis |
|---|---|---|
| geometry |
object |
Obiekt geometrii ma wartość null |
| kind |
string:
Route |
Rodzaj operacji asynchronicznej |
| properties |
Właściwości macierzy tras. |
|
| type |
Określa typ |
RouteMatrixFeatureProperties
Właściwości macierzy tras.
| Nazwa | Typ | Opis |
|---|---|---|
| matrix |
Macierz wyników trasy. |
|
| summary |
Podsumowanie żądania macierzy tras |
RouteMatrixItemResult
Wynik elementu macierzy tras
| Nazwa | Typ | Opis |
|---|---|---|
| arrivalAt |
string (date-time) |
Szacowany |
| departureAt |
string (date-time) |
Szacowany czas odjazdu, który uwzględnia warunki drogowe, jest sformatowany jako |
| 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 |
| error |
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
| Nazwa | 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. |