Udostępnij za pośrednictwem


Route - Get Route Operations Status

Uzyskaj status operacji asynchronicznej za pomocą jej identyfikatora operacji.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
endpoint
path True

string

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.

Odpowiedzi

Nazwa Typ Opis
200 OK

RouteOperation

Żą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 podmiot usługowy może otrzymać dostęp poprzez wbudowaną rolę lub niestandardową rolę składającą się z jednego lub więcej uprawnień do Azure Maps API REST.\n\nAby zaimplementować scenariusze, zalecamy zapoznanie się z koncepcjami authentication concepts. Podsumowując, ta definicja bezpieczeństwa zapewnia rozwiązanie do modelowania aplikacji(-ów) za pomocą obiektów zdolnych do kontroli dostępu do określonych API i zakresów.\n\n#### Uwagi\n* Ta definicja bezpieczeństwa wymaga użycia nagłówka x-ms-client-id do wskazania, do którego Azure Maps zasobu aplikacja żąda dostępu. Można ją uzyskać z API zarządzania Maps.\n* \nAuthorization URL jest specyficzny dla instancji Azure chmury publicznej. Suwerenne chmury mają unikalne adresy URL autoryzacji oraz konfiguracje Microsoft Entra ID. \n* \nKontrola dostępu oparta na rolach Azure jest konfigurowana z płaszczyzny zarządzania Azure za pośrednictwem Azure portalu, PowerShell, CLI, Azure SDKs lub API REST.\n* \nWykorzystanie Azure Maps Web SDK umożliwia konfigurację aplikacji dla wielu zastosowań.\n* Aby uzyskać więcej informacji o Platforma tożsamości Microsoft, zobacz przegląd Platforma tożsamości Microsoft przegląd.

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

Zakresy

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

subscription-key

Jest to klucz współdzielony, który jest przydzielany podczas Tworzenia konta Azure Maps w portalu Azure lub za pomocą PowerShell, CLI, Azure SDKs lub REST API.\n\n Dzięki temu kluczowi każda aplikacja może uzyskać dostęp do wszystkich API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, na którym są wydawane.\n\n W przypadku aplikacji udostępnionych publicznie zalecamy stosowanie podejścia confidential client applications do dostępu do API REST Azure Maps i bezpiecznie przechowywać klucz.

Typ: apiKey
W: header

SAS Token

Jest to token podpisu współdzielonego dostępu tworzony na podstawie operacji List SAS na Azure Maps resource przez płaszczyznę zarządzania Azure za pomocą Azure portalu, PowerShell, CLI, Azure SDKs lub API REST.\n\n Dzięki temu tokenowi każda aplikacja jest autoryzowana do dostępu za pomocą Azure kontrola dostępu oparta na rolach oraz precyzyjna kontrola do terminu wygaśnięcia, tempa i regionu użycia danego tokena. Innymi słowy, token SAS może być używany do umożliwienia aplikacjom kontrolowania dostępu w sposób bezpieczniejszy niż klucz współdzielony.\n\n W przypadku aplikacji udostępnionych publicznie zalecamy skonfigurowanie konkretnej listy dozwolonych źródeł na zasobach konta Map , aby ograniczyć nadużycia renderowania i regularnie odnawiać Token SAS.

Typ: apiKey
W: header

Przykłady

Retrieve the async matrix operation status

Przykładowe żądanie

GET {endpoint}/route/operations/bc3f9365-3ee0-4564-aa27-825016325557?api-version=2025-01-01

Przykładowa odpowiedź

{
  "createdAt": "2023-01-01T00:00:00Z",
  "kind": "RouteMatrix",
  "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"
  },
  "status": "Completed"
}
{
  "error": {
    "code": "NotFound",
    "message": "Not Found: the requested resource could not be found."
  }
}

Definicje

Nazwa Opis
CommonErrorDetail

Szczegóły błędu.

ErrorAdditionalInfo

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

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.

RouteOperation

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

RouteOperationKindEnum

Rodzaj operacji asynchronicznej

RouteOperationResult

Wynik pracy asynchronicznej

StatusEnum

Aktualny status operacji asynchronicznej.

CommonErrorDetail

Szczegóły błędu.

Nazwa 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.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

MapsErrorDetail

Szczegóły błędu.

Nazwa 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.

Nazwa Typ Opis
error

MapsErrorDetail

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

MapsInnerError

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

RouteOperation

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

Nazwa Typ Opis
createdAt

string (date-time)

Znacznik czasu utworzenia operacji.

error

CommonErrorDetail

Szczegóły błędu.

id

string

Unikalny identyfikator operacji asynchronicznej.

kind

RouteOperationKindEnum

Rodzaj operacji asynchronicznej

lastActionAt

string (date-time)

Znacznik czasu aktualizacji statusu operacji.

result

RouteOperationResult

Wynik pracy asynchronicznej

status

StatusEnum

Aktualny status operacji asynchronicznej.

RouteOperationKindEnum

Rodzaj operacji asynchronicznej

Wartość Opis
RouteMatrix

Zadanie asynchroniczne macierzy tras.

RouteOperationResult

Wynik pracy asynchronicznej

Nazwa Typ Opis
resultUrl

string (uri)

URL do uzyskania wyniku operacji asynchronicznej

StatusEnum

Aktualny status operacji asynchronicznej.

Wartość Opis
NotStarted

Operacja jeszcze się nie rozpoczęła.

Running

Operacja trwa.

Completed

Operacja zakończyła się pomyślnie.

Failed

Operacja nie powiodła się.