Snapshot - Get Operation Status

Referencia

Servicio:: Azure AI Services

Versión de la API:: 1.0-preview

Obtiene el estado de una operación de larga duración.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus.api.cognitive.microsoft.com).
operationId	path	True	string uuid	Identificador que hace referencia a una operación de toma o aplicación de instantánea determinada.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respuestas

Nombre	Tipo	Description
200 OK	OperationStatus	Una llamada correcta devuelve el estado de la operación.
Other Status Codes	APIError	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Get snapshot operation status example

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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
}

Definiciones

Nombre	Description
APIError	Información de error devuelta por la API
Error	Cuerpo del error.
OperationStatus	Objeto de estado de la operación. La operación hace referencia a una tarea de back-end asincrónica.
OperationStatusType	Estado de la operación: notstarted, running, succeeded, failed. Si se solicita la operación y espera a realizarla, no se iniciará el estado. Si la operación está en curso en el back-end, el estado se está ejecutando. Estado correcto significa que la operación se ha completado correctamente, específicamente para la operación de toma de instantáneas, muestra que la instantánea está bien tomada y lista para aplicarse, y para la operación de aplicación de instantáneas, presenta que el objeto de destino ha terminado de crearse mediante la instantánea y listo para usarse. El estado no se produce a menudo debido a la edición del objeto de origen mientras se toma la instantánea o se edita el objeto de destino mientras se aplica la instantánea antes de la finalización, vea el campo "message" para comprobar el motivo del error.

APIError

Información de error devuelta por la API

Nombre	Tipo	Description
error	Error	Cuerpo del error.

Error

Cuerpo del error.

Nombre	Tipo	Description
code	string
message	string

OperationStatus

Objeto de estado de la operación. La operación hace referencia a una tarea de back-end asincrónica.

Nombre	Tipo	Description
createdTime	string	Cadena de fecha y hora UTC combinada que describe la hora en que se solicita la operación. Por ejemplo, 2018-12-25T11:41:02.2331413Z.
finishedTime	string	Cadena de fecha y hora UTC combinada que describe la hora en que finaliza la operación. Por ejemplo, 2018-12-25T11:41:02.2331413Z.
lastActionTime	string	Cadena de fecha y hora UTC combinada que describe la última vez que se ejecuta activamente la operación. LastActionTime seguirá aumentando hasta que finalice la operación. Por ejemplo, 2018-12-25T11:51:27.8705696Z.
message	string	Mostrar mensaje de error cuando se produce un error en la operación (se omite cuando la operación se realiza correctamente).
resourceLocation	string	Cuando la operación se realiza correctamente, para la operación de toma de instantáneas, el identificador de instantánea se incluirá en este campo y, para la operación de aplicación de instantáneas, la ruta de acceso para obtener el objeto de destino se devolverá en este campo.
status	OperationStatusType	Estado de la operación: notstarted, running, succeeded, failed. Si se solicita la operación y espera a realizarla, no se iniciará el estado. Si la operación está en curso en el back-end, el estado se está ejecutando. Estado correcto significa que la operación se ha completado correctamente, específicamente para la operación de toma de instantáneas, muestra que la instantánea está bien tomada y lista para aplicarse, y para la operación de aplicación de instantáneas, presenta que el objeto de destino ha terminado de crearse mediante la instantánea y listo para usarse. El estado no se produce a menudo debido a la edición del objeto de origen mientras se toma la instantánea o se edita el objeto de destino mientras se aplica la instantánea antes de la finalización, vea el campo "message" para comprobar el motivo del error.

OperationStatusType

Estado de la operación: notstarted, running, succeeded, failed. Si se solicita la operación y espera a realizarla, no se iniciará el estado. Si la operación está en curso en el back-end, el estado se está ejecutando. Estado correcto significa que la operación se ha completado correctamente, específicamente para la operación de toma de instantáneas, muestra que la instantánea está bien tomada y lista para aplicarse, y para la operación de aplicación de instantáneas, presenta que el objeto de destino ha terminado de crearse mediante la instantánea y listo para usarse. El estado no se produce a menudo debido a la edición del objeto de origen mientras se toma la instantánea o se edita el objeto de destino mientras se aplica la instantánea antes de la finalización, vea el campo "message" para comprobar el motivo del error.

Nombre	Tipo	Description
failed	string
notStarted	string
running	string
succeeded	string

Compartir a través de