Snapshot - Get Operation Status

參考

服務:: Azure AI Services

API 版本:: 1.0-preview

取得長時間執行作業的狀態。

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

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點 (通訊協定和主機名，例如： https://westus.api.cognitive.microsoft.com) 。
operationId	path	True	string uuid	參考特定擷取/套用快照集作業的標識碼。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string

回應

名稱	類型	Description
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
}

定義

名稱	Description
APIError	API 傳回的錯誤資訊
Error	錯誤本文。
OperationStatus	作業狀態物件。作業是指異步後端工作。
OperationStatusType	作業狀態：未啟動、執行中、成功、失敗。如果要求作業並等候執行，則不會啟動狀態。如果作業在後端進行中，狀態為執行中。狀態成功表示作業已順利完成，特別是針對快照集擷取作業，它說明快照集已妥善擷取並準備好套用，而針對快照集套用作業，它會顯示目標物件已完成快照集建立並準備好使用。狀態失敗通常是在擷取快照集時編輯來源物件，或在完成前套用快照集時編輯目標物件所造成，請參閱字段「message」來檢查失敗原因。

APIError

API 傳回的錯誤資訊

名稱	類型	Description
error	Error	錯誤本文。

Error

錯誤本文。

名稱	類型	Description
code	string
message	string

OperationStatus

作業狀態物件。作業是指異步後端工作。

名稱	類型	Description
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	當作業成功時，針對快照集擷取作業，快照集標識元將會包含在此欄位中，而針對快照集套用作業，取得目標對象的路徑將會在此欄位中傳回。
status	OperationStatusType	作業狀態：未啟動、執行中、成功、失敗。如果要求作業並等候執行，則不會啟動狀態。如果作業在後端進行中，狀態為執行中。狀態成功表示作業已順利完成，特別是針對快照集擷取作業，它說明快照集已妥善擷取並準備好套用，而針對快照集套用作業，它會顯示目標物件已完成快照集建立並準備好使用。狀態失敗通常是在擷取快照集時編輯來源物件，或在完成前套用快照集時編輯目標物件所造成，請參閱字段「message」來檢查失敗原因。

OperationStatusType

作業狀態：未啟動、執行中、成功、失敗。如果要求作業並等候執行，則不會啟動狀態。如果作業在後端進行中，狀態為執行中。狀態成功表示作業已順利完成，特別是針對快照集擷取作業，它說明快照集已妥善擷取並準備好套用，而針對快照集套用作業，它會顯示目標物件已完成快照集建立並準備好使用。狀態失敗通常是在擷取快照集時編輯來源物件，或在完成前套用快照集時編輯目標物件所造成，請參閱字段「message」來檢查失敗原因。

名稱	類型	Description
failed	string
notStarted	string
running	string
succeeded	string

共用方式為