Creating Clone

POST /volume/{volume_id}/clone

Introduction

Creates a Clone of the specified Volume.

Creates a destination Volume (Volume to be a Clone) automatically and creates an OPC or QuickOPC Session with the specified Volume as the source.

Caution

  • Source Volume Types are Standard, TPV, FTV, and WSV (Except for the system volume).

  • The destination Volume Type is TPV only.

  • You cannot clone a Volume that has already been created (cannot create the destination OPC or QuickOPC Session).

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

  • You can check the status of the created Clone with "GET /volume/{volume_id}/copysession".

  • Concurrent OPC functionality is not supported.

  • When the OPC or QuickOPC 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.

  • For tenant users, only Thin Provisioning Pools that belong to the tenant of the current user can be specified.

  • If the creation destination Thin Provisioning Pool belongs to a tenant, the Clone to be created will also belong to the same tenant.

Request Examples

  • This is an example of creating a Clone of Volume ID 100001 in Thin Provisioning Pool ID 0. 
    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X POST "https://192.168.1.1:5665/api/v1/volume/100001/clone" -d
'{
"name": "clone#0",
"tpp_id": 0
}'

Response Examples

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

Parameters

PATH PARAMETERS

volume_id

(required)

integer

Volume ID.

REQUEST BODY

name

(required)

string

The destination Volume name to create.

Input criteria:

  • The available number of characters allowed is 1 to 32.

  • Acceptable characters are single byte alphanumeric characters. However, "," and "?" are excluded.

  • You cannot use a Volume name that already exists.

  • The following Volume names are not allowed:

    • Volume name starting with "$VVOL_META".

    • Volume name starting with "$DATA_CNTNR".

    • Volume name starting with "$SYSVOL".
tpp_id

(required)

ID of the destination Thin Provisioning Pool.

Input criteria:

  • The allowed values are 0 to 65535.

  • You cannot specify a Thin Provisioning Pool that does not exist.

  • For tenant users, Thin Provisioning Pools cannot be specified if they do not belong to the tenant of the current user.
is_data_tracking_disabled

boolean

Default: false

Whether to disable physical data resynchronization on the Clone.

If true, the Advanced Copy Session is automatically removed after the physical copy is complete, and physical data cannot be resynchronized (an OPC Session is created).

If false, the physical data in the destination Volume can be synchronized at any time (a QuickOPC Session is created) by keeping the region information of the updated part after Clone creation and using "POST/volume/{volume_id}/resync/{backup_volume_id}".

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.