AZazure

Changed on

Retrieve the status of a take/apply snapshot operation.

get/operations/{operationId}

Request

  • Base URL
    {Endpoint}/face/v1.0
  • URL
    {Endpoint}/face/v1.0/operations/{operationId}
  • Auth
    API key in header Ocp-Apim-Subscription-Key

Path parameters

operationIdstring uuid required

Id referencing a particular take/apply snapshot operation.

Response

A successful call returns the snapshot operation's status.

status'notstarted' | 'running' | 'succeeded' | 'failed' required

Operation status: notstarted, running, succeeded, failed. If the operation is requested and waiting to perform, the status is notstarted. If the operation is ongoing in backend, the status is running. Status succeeded means the operation is completed successfully, specifically for snapshot taking operation, it illustrates the snapshot is well taken and ready to apply, and for snapshot applying operation, it presents the target object has finished creating by the snapshot and ready to be used. Status failed is often caused by editing the source object while taking the snapshot or editing the target object while applying the snapshot before completion, see the field "message" to check the failure reason.

createdTimestring date-time required

A combined UTC date and time string that describes the time when the operation (take or apply a snapshot) is requested. E.g. 2018-12-25T11:41:02.2331413Z.

lastActionTimestring date-time

A combined UTC date and time string that describes the last time the operation (take or apply a snapshot) is actively migrating data. The lastActionTime will keep increasing until the operation finishes. E.g. 2018-12-25T11:51:27.8705696Z.

resourceLocationstring

When the operation succeeds successfully, for snapshot taking operation the snapshot id will be included in this field, and for snapshot applying operation, the path to get the target object will be returned in this field.

messagestring

Show failure message when operation fails (omitted when operation succeeds).

Changes