Creating REC Sessions

POST /copysession/rec

Introduction

Creates an REC Session.

Caution

  • The source/destination volume types are Standard, TPV, FTV, and WSV (Except for the system volume).

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

  • You can check the state of the created REC Session in "GET /copysession/{copysession_id}".

  • When the REC Session is created, the state of the Job becomes Success. The physical data is copied in the background.

  • The destination data cannot be viewed/updated until the Copy Session changes to the Suspend state.

  • If the Copy Session is not in the equivalent state, the destination data cannot be used as meaningful. When creating a Clone or Snapshot, issue a "POST /copysession/{copysession_id}/suspend" after the Copy Session has transitioned to the equivalent state.

  • Tenant users cannot execute this command.

Request Examples

  • An example of creating an REC Session from Volume ID 100001 on the storage system whose Box ID is 00ETERNUSDXHS3ET00000A####EI000000###### to Volume ID 200001 on the storage system whose Box ID is 00ETERNUSDXHS3ET00000A####EI000001######.
    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X POST "https://192.168.1.1:5665/api/v1/copysession/rec" -d 
'{
"source_volume_id": 100001,
"destination_volume_id": 200001,
"source_boxid": "00ETERNUSDXHS3ET00000A####EI000000######",
"destination_boxid": "00ETERNUSDXHS3ET00000A####EI000001######",
"transfer_mode": "Synchronous"
}'

Response Examples

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

Parameters

REQUEST BODY

source_volume_id

(required)

integer

Volume ID of the copy source volume.

Input criteria:

  • The allowed values are 0 to 6553465535.
destination_volume_id

(required)

integer

Volume ID of the copy destination volume.

Input criteria:

  • The allowed values are 0 to 6553465535.
source_boxid

(required)

The Box ID of the copy source device.

Input criteria:

  • Acceptable characters are as follows:

    • Capital letters

    • Numeric characters

    • Spaces

    • Pound sign The Box ID is 40 characters.

      You cannot specify a string that is not 40 characters long.
destination_boxid

(required)

The Box ID of the copy destination device.

Input criteria:

  • Acceptable characters are as follows:

    • Capital letters

    • Numeric characters

    • Spaces

    • Pound sign The Box ID is 40 characters.

      You cannot specify a string that is not 40 characters long.
transfer_mode

(required)

string

Copy Session transfer mode.
Items Description
Synchronous Synchronous mode
Stack Asynchronous Stack Mode
Consistency Asynchronous Consistency Mode
split_mode

string

Default: "Manual"

Copy Session Split Mode.
Items Description
Automatic Auto Split Mode
Manual Manual Split Mode

Input criteria:

  • Cannot be specified if the transfer mode of the Copy Session is other than Synchronous.
recovery_mode

string

Default: "Automatic"

Copy Session recovery mode.
Items Description
Automatic Automatic recovery mode
Manual Manual recovery mode

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.