Snapshot - Get Operation Status

Ссылка

Служба:: Azure AI Services

Версия API:: 1.0-preview

Получение состояния длительной операции.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например : https://westus.api.cognitive.microsoft.com).
operationId	path	True	string uuid	Идентификатор, ссылающийся на конкретную операцию принятия и применения snapshot.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string

Ответы

Имя	Тип	Описание
200 OK	OperationStatus	Успешный вызов возвращает состояние операции.
Other Status Codes	APIError	Ответ об ошибке.

Безопасность

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Get snapshot operation status example

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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
}

Определения

Имя	Описание
APIError	Сведения об ошибке, возвращаемые API
Error	Текст ошибки.
OperationStatus	Объект состояния операции. Операция относится к асинхронной серверной задаче.
OperationStatusType	Состояние операции: notstarted, running, succeeded, failed. Если операция запрашивается и ожидает выполнения, состояние не выполняется. Если операция выполняется в серверной части, состояние выполняется. Состояние успешно означает, что операция успешно завершена, в частности для snapshot операции принятия, иллюстрирует snapshot хорошо принят и готов к применению, а для snapshot операции применения он представляет, что целевой объект завершил создание snapshot и готов к использованию. Сбой состояния часто вызван изменением исходного объекта при принятии snapshot или изменением целевого объекта при применении snapshot перед завершением. Чтобы проверка причину сбоя, см. поле "сообщение".

APIError

Сведения об ошибке, возвращаемые API

Имя	Тип	Описание
error	Error	Текст ошибки.

Error

Текст ошибки.

Имя	Тип	Описание
code	string
message	string

OperationStatus

Объект состояния операции. Операция относится к асинхронной серверной задаче.

Имя	Тип	Описание
createdTime	string	Объединенная строка даты и времени в формате UTC, описывающая время запроса операции. Например, 2018-12-25T11:41:02.2331413Z.
finishedTime	string	Объединенная строка даты и времени в формате UTC, описывающая время завершения операции. Например, 2018-12-25T11:41:02.2331413Z.
lastActionTime	string	Объединенная строка даты и времени в формате UTC, описывающая время последнего активного выполнения операции. Значение lastActionTime будет увеличиваться до завершения операции. Например, 2018-12-25T11:51:27.8705696Z.
message	string	Отображение сообщения об ошибке при сбое операции (опущено при успешном выполнении операции).
resourceLocation	string	После успешного выполнения операции для snapshot принятия операции идентификатор snapshot будет включен в это поле, а для snapshot применения операции в этом поле будет возвращен путь для получения целевого объекта.
status	OperationStatusType	Состояние операции: notstarted, running, succeeded, failed. Если операция запрашивается и ожидает выполнения, состояние не выполняется. Если операция выполняется в серверной части, состояние выполняется. Состояние успешно означает, что операция успешно завершена, в частности для snapshot операции принятия, иллюстрирует snapshot хорошо принят и готов к применению, а для snapshot операции применения он представляет, что целевой объект завершил создание snapshot и готов к использованию. Сбой состояния часто вызван изменением исходного объекта при принятии snapshot или изменением целевого объекта при применении snapshot перед завершением. Чтобы проверка причину сбоя, см. поле "сообщение".

OperationStatusType

Состояние операции: notstarted, running, succeeded, failed. Если операция запрашивается и ожидает выполнения, состояние не выполняется. Если операция выполняется в серверной части, состояние выполняется. Состояние успешно означает, что операция успешно завершена, в частности для snapshot операции принятия, иллюстрирует snapshot хорошо принят и готов к применению, а для snapshot операции применения он представляет, что целевой объект завершил создание snapshot и готов к использованию. Сбой состояния часто вызван изменением исходного объекта при принятии snapshot или изменением целевого объекта при применении snapshot перед завершением. Чтобы проверка причину сбоя, см. поле "сообщение".

Имя	Тип	Описание
failed	string
notStarted	string
running	string
succeeded	string

Поделиться через