Snapshot - Get Operation Status

Referenz

Dienst:: Azure AI Services

API-Version:: 1.0-preview

Ruft status eines zeitintensiven Vorgangs ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus.api.cognitive.microsoft.com
operationId	path	True	string uuid	Id, die auf einen bestimmten Take/Apply-Momentaufnahme-Vorgang verweist.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Antworten

Name	Typ	Beschreibung
200 OK	OperationStatus	Bei einem erfolgreichen Aufruf wird die status des Vorgangs zurückgegeben.
Other Status Codes	APIError	Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

Get snapshot operation status example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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
}

Definitionen

Name	Beschreibung
APIError	Von der API zurückgegebene Fehlerinformationen
Error	Fehlertext.
OperationStatus	Vorgang status -Objekt. Vorgang bezieht sich auf eine asynchrone Back-End-Aufgabe.
OperationStatusType	Vorgang status: notstarted, running, succeeded, failed. Wenn der Vorgang angefordert wird und auf die Ausführung wartet, wird die status nicht ausgelöst. Wenn der Vorgang im Back-End ausgeführt wird, wird die status ausgeführt. Status erfolgreich bedeutet, dass der Vorgang erfolgreich abgeschlossen wurde, insbesondere für Momentaufnahme Vorgang, er veranschaulicht die Momentaufnahme ist gut genommen und bereit für die Anwendung, und für Momentaufnahme Anwendungsvorgang wird das Zielobjekt vom Momentaufnahme erstellt und bereit für die Verwendung angezeigt. Der Statusfehler wird häufig durch das Bearbeiten des Quellobjekts während des Momentaufnahme oder das Bearbeiten des Zielobjekts verursacht, während die Momentaufnahme vor abschluss angewendet wird. Weitere Informationen finden Sie im Feld "Meldung", um die Fehlerursache zu überprüfen.

APIError

Von der API zurückgegebene Fehlerinformationen

Name	Typ	Beschreibung
error	Error	Fehlertext.

Error

Fehlertext.

Name	Typ	Beschreibung
code	string
message	string

OperationStatus

Vorgang status -Objekt. Vorgang bezieht sich auf eine asynchrone Back-End-Aufgabe.

Name	Typ	Beschreibung
createdTime	string	Eine kombinierte UTC-Datums- und Uhrzeitzeichenfolge, die den Zeitpunkt beschreibt, zu dem der Vorgang angefordert wird. Beispiel: 2018-12-25T11:41:02.2331413Z.
finishedTime	string	Eine kombinierte UTC-Datums- und Uhrzeitzeichenfolge, die den Zeitpunkt beschreibt, zu dem der Vorgang abgeschlossen wurde. Beispiel: 2018-12-25T11:41:02.2331413Z.
lastActionTime	string	Eine kombinierte UTC-Datums- und Uhrzeitzeichenfolge, die den Zeitpunkt der letzten aktiven Ausführung des Vorgangs beschreibt. LastActionTime wird bis zum Abschluss des Vorgangs weiter erhöht. Beispiel: 2018-12-25T11:51:27.8705696Z.
message	string	Fehlermeldung anzeigen, wenn der Vorgang fehlschlägt (wird nicht angegeben, wenn der Vorgang erfolgreich ist).
resourceLocation	string	Wenn der Vorgang erfolgreich ist, wird für Momentaufnahme ausführenden Vorgang die Momentaufnahme-ID in dieses Feld eingeschlossen, und für Momentaufnahme anwendenden Vorgangs wird der Pfad zum Abrufen des Zielobjekts in diesem Feld zurückgegeben.
status	OperationStatusType	Vorgang status: notstarted, running, succeeded, failed. Wenn der Vorgang angefordert wird und auf die Ausführung wartet, wird die status nicht ausgelöst. Wenn der Vorgang im Back-End ausgeführt wird, wird die status ausgeführt. Status erfolgreich bedeutet, dass der Vorgang erfolgreich abgeschlossen wurde, insbesondere für Momentaufnahme Vorgang, er veranschaulicht die Momentaufnahme ist gut genommen und bereit für die Anwendung, und für Momentaufnahme Anwendungsvorgang wird das Zielobjekt vom Momentaufnahme erstellt und bereit für die Verwendung angezeigt. Der Statusfehler wird häufig durch das Bearbeiten des Quellobjekts während des Momentaufnahme oder das Bearbeiten des Zielobjekts verursacht, während die Momentaufnahme vor abschluss angewendet wird. Weitere Informationen finden Sie im Feld "Meldung", um die Fehlerursache zu überprüfen.

OperationStatusType

Vorgang status: notstarted, running, succeeded, failed. Wenn der Vorgang angefordert wird und auf die Ausführung wartet, wird die status nicht ausgelöst. Wenn der Vorgang im Back-End ausgeführt wird, wird die status ausgeführt. Status erfolgreich bedeutet, dass der Vorgang erfolgreich abgeschlossen wurde, insbesondere für Momentaufnahme Vorgang, er veranschaulicht die Momentaufnahme ist gut genommen und bereit für die Anwendung, und für Momentaufnahme Anwendungsvorgang wird das Zielobjekt vom Momentaufnahme erstellt und bereit für die Verwendung angezeigt. Der Statusfehler wird häufig durch das Bearbeiten des Quellobjekts während des Momentaufnahme oder das Bearbeiten des Zielobjekts verursacht, während die Momentaufnahme vor abschluss angewendet wird. Weitere Informationen finden Sie im Feld "Meldung", um die Fehlerursache zu überprüfen.

Name	Typ	Beschreibung
failed	string
notStarted	string
running	string
succeeded	string

Freigeben über