Snapshot - Get Operation Status

リファレンス

サービス:: Azure AI Services

API バージョン:: 1.0

取得/適用スナップショット操作の状態を取得します。

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

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://westus.api.cognitive.microsoft.com
operationId	path	True	string uuid	特定の take/apply スナップショット操作を参照する 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/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

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

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

Error

エラー本文。

名前	型	説明
code	string
message	string

OperationStatus

操作状態オブジェクト。操作とは、スナップショットの取得やスナップショットの適用を含む非同期バックエンドタスクを指します。

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

OperationStatusType

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

名前	型	説明
failed	string
notstarted	string
running	string
succeeded	string

次の方法で共有