Snapshot - Get Operation Status

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 1.0-preview

Uzyskaj stan długotrwałej operacji.

GET {Endpoint}/face/v1.0-preview/operations/{operationId}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus.api.cognitive.microsoft.com).
operationId	path	True	string uuid	Identyfikator odwołujący się do określonej operacji tworzenia/stosowania migawki.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Odpowiedzi

Nazwa	Typ	Opis
200 OK	OperationStatus	Pomyślne wywołanie zwraca stan operacji.
Other Status Codes	APIError	Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

Przykłady

Get snapshot operation status example

Przykładowe żądanie

HTTP

GET {Endpoint}/face/v1.0-preview/operations/a63a3bdd-a1db-4d05-87b8-dbad6850062a

Przykładowa odpowiedź

Kod stanu:: 200

{
  "status": "succeeded",
  "createdTime": "2018-12-25T11:41:02.2331413Z",
  "lastActionTime": "2018-12-25T11:51:27.8705696Z",
  "resourceLocation": "/snapshots/e58b3f08-1e8b-4165-81df-aa9858f233dc",
  "message": null
}

Definicje

Nazwa	Opis
APIError	Informacje o błędzie zwrócone przez interfejs API
Error	Treść błędu.
OperationStatus	Obiekt stanu operacji. Operacja odnosi się do asynchronicznego zadania zaplecza.
OperationStatusType	Stan operacji: niestarted, uruchomione, zakończone pomyślnie, zakończone niepowodzeniem. Jeśli operacja jest żądana i oczekuje na wykonanie, stan nie zostanie uruchomiony. Jeśli operacja trwa w zapleczu, stan jest uruchomiony. Stan powodzenia oznacza, że operacja została ukończona pomyślnie, w szczególności w przypadku operacji tworzenia migawki, ilustruje, że migawka jest dobrze wykonana i gotowa do zastosowania, a w przypadku operacji stosowania migawki przedstawia obiekt docelowy został ukończony przez migawkę i jest gotowy do użycia. Stan nie powiódł się często przez edytowanie obiektu źródłowego podczas wykonywania migawki lub edytowania obiektu docelowego podczas stosowania migawki przed ukończeniem, zobacz pole "message", aby sprawdzić przyczynę niepowodzenia.

APIError

Informacje o błędzie zwrócone przez interfejs API

Nazwa	Typ	Opis
error	Error	Treść błędu.

Error

Treść błędu.

Nazwa	Typ	Opis
code	string
message	string

OperationStatus

Obiekt stanu operacji. Operacja odnosi się do asynchronicznego zadania zaplecza.

Nazwa	Typ	Opis
createdTime	string	Połączony ciąg daty i godziny UTC, który opisuje godzinę żądania operacji. Np. 2018-12-25T11:41:02.2331413Z.
finishedTime	string	Połączony ciąg daty i godziny UTC, który opisuje godzinę zakończenia operacji. Np. 2018-12-25T11:41:02.2331413Z.
lastActionTime	string	Połączony ciąg daty i godziny UTC, który opisuje czas ostatniej operacji jest aktywnie uruchamiany. Funkcja lastActionTime będzie stale zwiększana do momentu zakończenia operacji. Np. 2018-12-25T11:51:27.8705696Z.
message	string	Pokaż komunikat o niepowodzeniu, gdy operacja zakończy się niepowodzeniem (pominięto, gdy operacja zakończy się pomyślnie).
resourceLocation	string	Po pomyślnym pomyślnym zakończeniu operacji tworzenia migawki identyfikator migawki zostanie uwzględniony w tym polu, a w przypadku operacji stosowania migawki ścieżka do pobrania obiektu docelowego zostanie zwrócona w tym polu.
status	OperationStatusType	Stan operacji: niestarted, uruchomione, zakończone pomyślnie, zakończone niepowodzeniem. Jeśli operacja jest żądana i oczekuje na wykonanie, stan nie zostanie uruchomiony. Jeśli operacja trwa w zapleczu, stan jest uruchomiony. Stan powodzenia oznacza, że operacja została ukończona pomyślnie, w szczególności w przypadku operacji tworzenia migawki, ilustruje, że migawka jest dobrze wykonana i gotowa do zastosowania, a w przypadku operacji stosowania migawki przedstawia obiekt docelowy został ukończony przez migawkę i jest gotowy do użycia. Stan nie powiódł się często przez edytowanie obiektu źródłowego podczas wykonywania migawki lub edytowania obiektu docelowego podczas stosowania migawki przed ukończeniem, zobacz pole "message", aby sprawdzić przyczynę niepowodzenia.

OperationStatusType

Stan operacji: niestarted, uruchomione, zakończone pomyślnie, zakończone niepowodzeniem. Jeśli operacja jest żądana i oczekuje na wykonanie, stan nie zostanie uruchomiony. Jeśli operacja trwa w zapleczu, stan jest uruchomiony. Stan powodzenia oznacza, że operacja została ukończona pomyślnie, w szczególności w przypadku operacji tworzenia migawki, ilustruje, że migawka jest dobrze wykonana i gotowa do zastosowania, a w przypadku operacji stosowania migawki przedstawia obiekt docelowy został ukończony przez migawkę i jest gotowy do użycia. Stan nie powiódł się często przez edytowanie obiektu źródłowego podczas wykonywania migawki lub edytowania obiektu docelowego podczas stosowania migawki przed ukończeniem, zobacz pole "message", aby sprawdzić przyczynę niepowodzenia.

Nazwa	Typ	Opis
failed	string
notStarted	string
running	string
succeeded	string

Udostępnij za pośrednictwem