Snapshot - Get Operation Status

Referência

Serviço:: Azure AI Services

Versão da API:: 1.0-preview

Obter o estado de uma operação de execução prolongada.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus.api.cognitive.microsoft.com).
operationId	path	True	string uuid	ID que referencia uma determinada operação de captura/aplicação de instantâneos.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respostas

Name	Tipo	Description
200 OK	OperationStatus	Uma chamada bem-sucedida devolve o estado da operação.
Other Status Codes	APIError	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Get snapshot operation status example

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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
}

Definições

Name	Description
APIError	Informações de erro devolvidas pela API
Error	Corpo do erro.
OperationStatus	Objeto de estado da operação. A operação refere-se a uma tarefa de back-end assíncrona.
OperationStatusType	Estado da operação: notstarted, running, succeeded, failed. Se a operação for pedida e a aguardar a execução, o estado não será inicial. Se a operação estiver em curso no back-end, o estado está em execução. O estado com êxito significa que a operação foi concluída com êxito, especificamente para a operação de criação de instantâneos, ilustra que o instantâneo está bem tirado e pronto para ser aplicado e, para a operação de aplicação de instantâneos, apresenta que o objeto de destino terminou de criar pelo instantâneo e está pronto para ser utilizado. O estado falhado é frequentemente causado pela edição do objeto de origem ao tirar o instantâneo ou editar o objeto de destino enquanto aplica o instantâneo antes da conclusão. Veja o campo "mensagem" para verificar o motivo da falha.

APIError

Informações de erro devolvidas pela API

Name	Tipo	Description
error	Error	Corpo do erro.

Error

Corpo do erro.

Name	Tipo	Description
code	string
message	string

OperationStatus

Objeto de estado da operação. A operação refere-se a uma tarefa de back-end assíncrona.

Name	Tipo	Description
createdTime	string	Uma cadeia de data e hora UTC combinada que descreve a hora em que a operação é pedida. Por exemplo, 2018-12-25T11:41:02.2331413Z.
finishedTime	string	Uma cadeia de data e hora UTC combinada que descreve a hora em que a operação foi concluída. Por exemplo, 2018-12-25T11:41:02.2331413Z.
lastActionTime	string	Uma cadeia de data e hora UTC combinada que descreve a última vez que a operação está a ser executada ativamente. O lastActionTime continuará a aumentar até a operação ser concluída. Por exemplo, 2018-12-25T11:51:27.8705696Z.
message	string	Mostrar mensagem de falha quando a operação falhar (omitido quando a operação for bem-sucedida).
resourceLocation	string	Quando a operação for bem-sucedida, para a operação de criação de instantâneos, o ID de instantâneo será incluído neste campo e, para a operação de aplicação de instantâneos, o caminho para obter o objeto de destino será devolvido neste campo.
status	OperationStatusType	Estado da operação: notstarted, running, succeeded, failed. Se a operação for pedida e a aguardar a execução, o estado não será inicial. Se a operação estiver em curso no back-end, o estado está em execução. O estado com êxito significa que a operação foi concluída com êxito, especificamente para a operação de criação de instantâneos, ilustra que o instantâneo está bem tirado e pronto para ser aplicado e, para a operação de aplicação de instantâneos, apresenta que o objeto de destino terminou de criar pelo instantâneo e está pronto para ser utilizado. O estado falhado é frequentemente causado pela edição do objeto de origem ao tirar o instantâneo ou editar o objeto de destino enquanto aplica o instantâneo antes da conclusão. Veja o campo "mensagem" para verificar o motivo da falha.

OperationStatusType

Estado da operação: notstarted, running, succeeded, failed. Se a operação for pedida e a aguardar a execução, o estado não será inicial. Se a operação estiver em curso no back-end, o estado está em execução. O estado com êxito significa que a operação foi concluída com êxito, especificamente para a operação de criação de instantâneos, ilustra que o instantâneo está bem tirado e pronto para ser aplicado e, para a operação de aplicação de instantâneos, apresenta que o objeto de destino terminou de criar pelo instantâneo e está pronto para ser utilizado. O estado falhado é frequentemente causado pela edição do objeto de origem ao tirar o instantâneo ou editar o objeto de destino enquanto aplica o instantâneo antes da conclusão. Veja o campo "mensagem" para verificar o motivo da falha.

Name	Tipo	Description
failed	string
notStarted	string
running	string
succeeded	string

Partilhar via