Restoring from Clone or Snapshot

POST /volume/{volume_id}/restore/{backup_volume_id}

Introduction

Starts a restore from Clone or Snapshot.

Creates a restore OPC Session from Clone or Snapshot to its source Volume.

Caution

  • You can find the Href of the created restore OPC Session in resource_href_list of "GET /job/{job_id}".

  • You can check the progress of the restore from Clone or Snapshot in "GET /copysession/{copysession _ id}".

  • When the restore OPC Session is created, the state of the Job becomes Success. The physical data is copied in the background. The destination Volume can be accessed while the physical data is being copied.

  • Performing a restore OPC to SnapOPC+ Session may result in increased refreshes for the latest generation of SnapOPC+. Before restoring, ensure that there is enough free space to hold the backup data.

  • For tenant users, a restore cannot be performed if the copy source volume or the copy destination volume does not belong to the tenant of the current user.

Request Examples

  • This is an example of starting a restore from Volume ID 200001 to Volume ID 100001.
    $ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X POST "https://192.168.1.1:5665/api/v1/volume/100001/restore/200001"

Response Examples

{
  "job_id": 8192001,
  "job_href": "/api/v1/job/8192001"
}

Parameters

PATH PARAMETERS

volume_id

(required)

integer

Volume ID.
backup_volume_id

(required)

integer

Volume ID of the backup volume.

Responses

If the job registration is successful, the HTTP status code will be 202 (Accepted) and the response body will respond.

RESPONSE BODY

job_id

integer

Job ID.
job_href

string

Resource link of the job.