Obtaining the Session Information

GET /copysession/{copysession_id}

Introduction

Obtains the specified Copy Session information.

Caution

The Storage Cluster and VVOL Copy Session information is not returned.

Request Examples

This is an example of obtaining only the ID, Type, and Status for a Copy Session with ID 2.

$ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/copysession/2?fields=type,status"

Response Examples

{
  "copysession_id": 0,
  "copysession_href": "/api/v1/copysession/0",
  "type": "OPC",
  "status": "Active",
  "source_volume_number": 1,
  "source_volume_href": "/api/v1/volume/100001",
  "source_volume_name": "hoge#1",
  "destination_volume_number": 2,
  "destination_volume_href": "/api/v1/volume/200001",
  "destination_volume_name": "hoge#2",
  "phase": "Equivalent",
  "error_code": "b1",
  "copy_range": "Totally",
  "concurrent_suspend_result": "Running",
  "remain_time_to_finish_suspend": 33,
  "elapsed_time": 83920,
  "backup_time": "2020-12-01T12:30:00Z",
  "error_ocurrence_time": "2020-12-01T12:30:00Z",
  "total_data_size": 3812,
  "uncopied_data_size": 3812,
  "progress": 30,
  "requestor": "REST",
  "resolution": 16,
  "generation": 1,
  "generation_count": 3,
  "tracking_data_size": 34,
  "remote_copysession_id": 1,
  "transfer_mode": "Consistency",
  "split_mode": "Manual",
  "recovery_mode": "Manual",
  "remote_boxid": "00ETERNUSDXHS3ET00000A####EI000001######",
  "is_local_source_volume": true
}

Parameters

PATH PARAMETERS

copysession_id

(required)

integer

Copy Session ID.

QUERY PARAMETERS

fields

Array of strings

Parameter to display.

Only the information of the specified Parameter name (Response Body Parameter) is extracted and obtained.

For details about the specification methods, see Property Filter.

Responses

If successful, the HTTP status code is 200 (OK) and the response body is returned.

RESPONSE BODY

copysession_id

integer

Copy Session ID.

copysession_href

string

Resource link of the Copy Session.

type

string

Copy Session Type.

Item	Type
OPC	OPC Session
QuickOPC	QuickOPC Session
SnapOPC	SnapOPC Session
SnapOPCPlus	SnapOPC+ Session
EC	EC Session
REC	REC Session
Monitor	Monitor Session
XCOPY	Extended Copy Session
ODX	Offloaded Data Transfer Session

status

string

Copy Session status.

Item	Description
Active	Operating normally.
Reserved	Copy Session ID Reserved.
Suspended	Suspended.
Halt	Copying is suspended due to copy path error or depletion of REC buffer. If the Recovery Mode is Automatic, copying resumes automatically after the Halt factor is recovered. If the Recovery Mode is Manual, copying must be manually restarted by force Suspend/Resume after recovery.
Error	Copying was stopped due to equipment failure or insufficient capacity. The Copy Session must be deleted and recreated after the error causes have been recovered.

source_volume_number

integer

Number of the source Volume.

It does not respond if the Copy Session Status is Reserved.

For tenant users, a response is returned even if the copy source volume does not belong to the tenant of the current user.

source_volume_href

string

Link to copy source Volume Resource.

It does not respond if the Copy Session Status is Reserved.

It will not respond if the Copy Session Type is REC and is_local_source_volume is false.

For tenant users, a response is returned even if the copy source volume does not belong to the tenant of the current user.

source_volume_name

string

Friendly Name of the source Volume.

It does not respond if the Copy Session Status is Reserved.

It will not respond if the Copy Session Type is REC and is_local_source_volume is false.

For tenant users, no response is returned if the copy source volume does not belong to the tenant of the current user.

destination_volume_number

integer

Number of the source Volume.

It does not respond if the Copy Session Type is Monitor.

It does not respond if the Copy Session Status is Reserved.

For tenant users, a response is returned even if the copy destination volume does not belong to the tenant of the current user.

destination_volume_href

string

Link to copy destination Volume Resource.

It does not respond if the Copy Session Type is Monitor.

It does not respond if the Copy Session Status is Reserved.

It will not respond if the Copy Session Type is REC and is_local_source_volume is true.

For tenant users, a response is returned even if the copy destination volume does not belong to the tenant of the current user.

destination_volume_name

string

Friendly Name of the destination Volume.

It does not respond if the Copy Session Type is Monitor.

It does not respond if the Copy Session Status is Reserved.

It will not respond if the Copy Session Type is REC and is_local_source_volume is true.

For tenant users, no response is returned if the copy destination volume does not belong to the tenant of the current user.

phase

string

Phase of the Copy Session.

It does not respond if the Copy Session Type is XCOPY or ODX.

It does not respond if the Copy Session Status is Reserved.

If Copy Session Type is OPC, SnapOPC, or SnapOPC+, the phases that can be responded are Copying and Reading.

If Copy Session Type is QuickOPC, the phases that can be responded are Copying, Tracking, and Tracking_and_Copying.

If Copy Session Type is EC or REC, the phases that can be responded are Copying and Equivalent.

Item	Description
Copying	Indicates that a copy is in progress if Copy Session Type is OPC, SnapOPC, or SnapOPC+. In the case of QuickOPC, this phase indicates the recording of the update part has been stopped and the recorded update part is being copied. In the case of EC, REC (synchronous mode), or REC (Asynchronous Consistency Mode), this phase indicates that the data integrity of the destination is not guaranteed because the data copy to the destination Volume is in progress or the data copy is being forcibly interrupted. In the case of REC (Asynchronous Stack Mode), this phase indicates that the data of the source volume and the destination volume do not match. In the case of Monitor, this phase indicates that the updated part is being recorded.
Equivalent	In the case of EC, REC (synchronous mode), or REC (Asynchronous Stack Mode), the copy-source volume and copy-destination volume data match, and the consistency of the copy-destination data is guaranteed. In the case of a REC (Asynchronous Consistency Mode), the destination data is guaranteed to be consistent (If there is untransferred data in the REC Buffer, the copy source data does not match with the copy destination data.).
Tracking	After copying with QuickOPC, only the updated part is being recorded.
Tracking_and_Copying	QuickOPC is in the process of copying and is recording updates since the start of copying.
Readying	Preparing to start copy.

error_code

string

The error code for the error.

It does not respond if the Copy Session Status is Reserved.

Item	Description
10 - 1f	Error caused by source volume. Some source volumes are inaccessible due to a failed drive or drive enclosure.
20 - 2f	Error caused by destination volume. Some destination volumes are inaccessible due to a failed drive or drive enclosure.
30 - 3f	Error caused by copy path. Check the status of the copy path.
b1	This copy session also terminated with an error due to an error that occurred in the source session while cascade copy was configured.
ba	There is a bad sector.
bb	The capacity of SDV/SDP is insufficient.
bd	The destination volume or device is overloaded.
be	Data is being accumulated in the REC buffer due to a line error. Appears only if the Copy Session Type is REC.
bf	Data is being accumulated in the REC disk buffer due to a line error. Appears only if the Copy Session Type is REC.

copy_range

string

Copy Session copy range.

It does not respond if the Copy Session Status is Reserved.

Item	Description
Totally	The entire volume.
Extent	Part of a volume.

concurrent_suspend_result

string

Concurrent Suspend transition state for the Copy Session.

If Concurrent Suspend is not started, Success is displayed.

It responds only if the Copy Session Type is EC or REC.

It does not respond if the Copy Session Status is Reserved.

Item	Description
Success	Suspend migration ended.
Running	Transitioning to Suspend.
Error	Suspend migration failed.
Unknown	Suspend migration status unknown.

remain_time_to_finish_suspend

integer

Estimated time to complete Suspend migration.

The unit is seconds.

It responds only if the Copy Session Type is EC or REC.

It does not respond if the Copy Session Status is Reserved.

This item is returned only if the Concurrent Suspend transition state is Running.

If there is an error in the REC route, the maximum value (4294967295) may be answered.

elapsed_time

integer

Elapsed time since the Copy Session was registered.

The unit is seconds.

It does not respond if the Copy Session Status is Reserved.

backup_time

string

The backup start time for the Copy Session.

It does not respond if the Copy Session Status is Error, Reserved, or Halt.

Format is as follows:

The time zone is UTC.

YYYY-MM-DDThh:mm:ssZ

error_ocurrence_time

string

Time the Copy Session failed.

It responds only if the Copy Session Status is Error or Halt.

Format is as follows:

The time zone is UTC.

YYYY-MM-DDThh:mm:ssZ

total_data_size

integer

The size of the data to be copied.

It usually matches with the Capacity of the copy-source volume.

The unit is MB.

It does not respond if the Copy Session Status is Reserved.

uncopied_data_size

integer

Uncopied data size.

The unit is MB.

For OPC, QuickOPC, EC, or REC

When a Copy Session is created, it usually matches with the Capacity of the Source Volume and decreases as the physical data copy progresses.
For QuickOPC

When a restart (Clone Resynchronization) is performed, the amount of difference data in the copy-source volume since the last restart is added.

A value of 0 indicates that the background physical data copy is complete.
For EC or REC

The Uncopied Data Size increases when the data in the copy-source volume is updated.

A value of 0 indicates that the data of the Copy source/destination Volume is in the equivalent state.
For SnapOPC or SnapOPC+

It is fixed to 0.

It does not respond if the Copy Session Status is Reserved.

If total_data_size is 0, no response is made.

progress

integer

Physical copy progress rate.

The unit is %.

It does not respond if the Copy Session Status is Reserved.

If total_data_size is false, no response is made.

requestor

string

The client that started the Copy Session.

It does not respond if the Copy Session Type is XCOPY or ODX.

It does not respond if the Copy Session Status is Reserved.

Item	Description
SCSI	The Copy Session requested by the copy control software (via SCSI).
LAN	The Copy Session requested by the copy control software (via LAN).
CLI	Copy Session requested from CLI command.
GUI	The Copy Session requested from Web GUI.
SMIS	The Copy Session requested from SMI-S.
REST	The Copy Session requested from RESTful API.

resolution

integer

Copy Session resolution.

It does not respond if the Copy Session Type is XCOPY or ODX.

It does not respond if the Copy Session Status is Reserved.

generation

integer

Copy Session generation.

It responds only if the Copy Session Type is SnapOPC+.

It does not respond if the Copy Session Status is Reserved.

generation_count

integer

Total number of copy session generations.

It responds only if the Copy Session Type is SnapOPC+.

It does not respond if the Copy Session Status is Reserved.

tracking_data_size

integer

The size of the data in tracking.

The unit is MB.

Responds the amount of difference since the start of resynchronization.

It responds only if the Copy Session Type is QuickOPC.

It does not respond if the Copy Session Status is Reserved.

remote_copysession_id

integer

The Copy Session ID of the destination device.

It responds only if the Copy Session Type is REC.

It does not respond if the Copy Session Status is Reserved.

transfer_mode

string

Copy Session transfer mode.

It responds only if the Copy Session Type is REC.

It does not respond if the Copy Session Status is Reserved.

Item	Description
Synchronous	Synchronous Mode
Through	Asynchronous Through Mode
Stack	Asynchronous Stack Mode
Consistency	Asynchronous Consistency Mode

split_mode

string

Copy Session Split Mode.

It responds only if the Copy Session Type is REC.

It does not respond if the Copy Session Status is Reserved.

Responds only if Copy Session transfer mode is Synchronous (synchronous mode).

Item	Description
Automatic	Auto Split Mode
Manual	Manual Split Mode

recovery_mode

string

Copy Session recovery mode.

It responds only if the Copy Session Type is REC.

It does not respond if the Copy Session Status is Reserved.

Item	Description
Automatic	Automatic recovery mode
Manual	Manual recovery mode

remote_boxid

string

The Box ID of the destination device.

It responds only if the Copy Session Type is REC.

It does not respond if the Copy Session Status is Reserved.

is_local_source_volume

boolean

Whether the source Volume of the REC Session exists on the local device.

If true, the copy source of the REC Session is the local device.

If false, the copy source of the REC Session is the remote device.

It responds only if the Copy Session Type is REC.

It does not respond if the Copy Session Status is Reserved.