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)	特定の取得/適用スナップショット操作を参照する ID。

要求ヘッダー

名前	必須	型	説明
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	操作の状態: 未開始、実行中、成功、失敗。 操作が要求され、実行を待機している場合、状態は開始されません。 操作がバックエンドで進行中の場合、状態は実行中です。 状態が成功したとは、操作が正常に完了したことを意味します。具体的には、スナップショットの作成操作、スナップショットが適切に作成され、適用する準備ができていることを示しています。スナップショットの適用操作では、ターゲット オブジェクトがスナップショットによって作成が完了し、使用する準備ができたことを示します。 状態の失敗は、多くの場合、スナップショットの作成中にソース オブジェクトを編集したり、完了前にスナップショットを適用しているときにターゲット オブジェクトを編集したりすることによって発生します。失敗の理由を確認するには、フィールド "message" を参照してください。

APIError

Object

API によって返されるエラー情報

名前	型	説明
error	Error	エラー本文。

Error

Object

エラー本文。

名前	型	説明
code	string
message	string

OperationStatus

Object

操作状態オブジェクト。 操作は非同期バックエンド タスクを指します。

名前	型	説明
createdTime	string (date-time)	操作が要求された時刻を表す UTC 日付と時刻の組み合わせ文字列。 例: 2018-12-25T11:41:02.2331413Z。
finishedTime	string (date-time)	操作が完了した時刻を表す UTC 日付と時刻の組み合わせ文字列。 例: 2018-12-25T11:41:02.2331413Z。
lastActionTime	string (date-time)	操作がアクティブに実行されている最後の時刻を表す UTC 日付と時刻の組み合わせ文字列。 lastActionTime は、操作が完了するまで増加し続けます。 例: 2018-12-25T11:51:27.8705696Z。
message	string	操作が失敗したときにエラー メッセージを表示します (操作が成功した場合は省略されます)。
resourceLocation	string	操作が正常に成功すると、スナップショット取得操作の場合、スナップショット ID がこのフィールドに含まれます。スナップショット適用操作の場合は、ターゲット オブジェクトを取得するためのパスがこのフィールドに返されます。
status	OperationStatusType	操作の状態: 未開始、実行中、成功、失敗。 操作が要求され、実行を待機している場合、状態は開始されません。 操作がバックエンドで進行中の場合、状態は実行中です。 状態が成功したとは、操作が正常に完了したことを意味します。具体的には、スナップショットの作成操作、スナップショットが適切に作成され、適用する準備ができていることを示しています。スナップショットの適用操作では、ターゲット オブジェクトがスナップショットによって作成が完了し、使用する準備ができたことを示します。 状態の失敗は、多くの場合、スナップショットの作成中にソース オブジェクトを編集したり、完了前にスナップショットを適用しているときにターゲット オブジェクトを編集したりすることによって発生します。失敗の理由を確認するには、フィールド "message" を参照してください。

OperationStatusType

列挙

操作の状態: 未開始、実行中、成功、失敗。 操作が要求され、実行を待機している場合、状態は開始されません。 操作がバックエンドで進行中の場合、状態は実行中です。 状態が成功したとは、操作が正常に完了したことを意味します。具体的には、スナップショットの作成操作、スナップショットが適切に作成され、適用する準備ができていることを示しています。スナップショットの適用操作では、ターゲット オブジェクトがスナップショットによって作成が完了し、使用する準備ができたことを示します。 状態の失敗は、多くの場合、スナップショットの作成中にソース オブジェクトを編集したり、完了前にスナップショットを適用しているときにターゲット オブジェクトを編集したりすることによって発生します。失敗の理由を確認するには、フィールド "message" を参照してください。

値	説明
failed
notStarted
running
succeeded