Udostępnij przez


Route - Get Route Operations Status

Pobierz stan operacji asynchronicznej według identyfikatora operacji.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
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

Numer wersji interfejsu API usługi Azure Maps.

Odpowiedzi

Nazwa Typ Opis
200 OK

RouteOperation

OK

404 Not Found

ErrorResponse

Nie znaleziono zasobu operacyjnego.

Nagłówki

x-ms-error-code: string

Other Status Codes

ErrorResponse

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-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ą 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 operation status

Przykładowe żądanie

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

Przykładowa odpowiedź

{
  "kind": "RouteMatrix",
  "status": "Completed",
  "createdAt": "2023-01-01T00:00:00Z",
  "lastActionAt": "2023-01-01T00:05:00Z",
  "result": {
    "resultUrl": "https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2025-01-01"
  }
}
{
  "error": {
    "code": "NotFound",
    "message": "Not Found: the requested resource could not be found."
  }
}

Definicje

Nazwa Opis
ErrorAdditionalInfo

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

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

Result

Wynik operacji asynchronicznej

RouteOperation

Ten obiekt jest zwracany z pomyślnego żądania Get Operation.

RouteOperationKindEnum

Rodzaj operacji asynchronicznej

StatusEnum

Bieżący stan 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

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

ErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

Result

Wynik operacji asynchronicznej

Nazwa Typ Opis
resultUrl

string (uri)

Adres URL do pobierania wyniku operacji asynchronicznej

RouteOperation

Ten obiekt jest zwracany z pomyślnego żądania Get Operation.

Nazwa Typ Opis
createdAt

string (date-time)

Sygnatura czasowa utworzenia operacji.

error

ErrorDetail

Szczegóły błędu.

id

string

Niepowtarzalny identyfikator operacji asynchronicznej.

kind

RouteOperationKindEnum

Rodzaj operacji asynchronicznej

lastActionAt

string (date-time)

Sygnatura czasowa, kiedy stan operacji został zaktualizowany.

result

Result

Wynik operacji asynchronicznej

status

StatusEnum

Bieżący stan operacji asynchronicznej.

RouteOperationKindEnum

Rodzaj operacji asynchronicznej

Wartość Opis
RouteMatrix

Zadanie asynchroniczne macierzy tras.

StatusEnum

Bieżący stan operacji asynchronicznej.

Wartość Opis
NotStarted

Operacja nie została jeszcze uruchomiona.

Running

Operacja jest w toku.

Completed

Operacja została ukończona pomyślnie.

Failed

Operacja nie powiodła się.