Obtaining All the Copy Session Information

Introduction

Obtains the Copy Session information.

The information is sorted by copysession id in ascending order.

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.

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

Response Examples

{
  "total_count": 512,
  "list_count": 1,
  "copysession_list": [
    {
      "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
    }
  ],
  "next_href": "/api/v1/volume?is_used_status_attention=true&fields=number,name&last_get_id=100005"
}

Parameters

QUERY PARAMETERS

fields

Array of strings

Parameter to display.

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

For details about the specification methods, see Property Filter.

copysession_id

Array of integers

Copy Session ID.

Specify the Copy Session ID for which you want information.

Input criteria:

You can specify up to 256 values.

type

Array of strings

Copy Session Type.

Specify the Copy Session Type for which you want information.

Items	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

Array of strings

Status.

Specify the Copy Session Status for which you want information.

Items	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. After the error causes have been recovered, the Copy Session must be deleted and recreated.

phase

Array of strings

Phase.

Specify the Copy Session Phase for which you want information.

Items	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.

max_records

The maximum number of resources for which you want information.

Specify this parameter when you want to limit the number of pieces of information that can be answered.

Input criteria:

The range of allowed values is 1 to 512.

start_number

Default: 0

The first number of the resource for which you want information.

Input criteria:

The allowed values are 0 to 65535.

last_get_id

integer

The identifier of the resource for which to retrieve further information.

If all resources matching with the response conditions cannot be answered at once, next_href is returned.

The last_get_id is the information given to next_href to retrieve further information.

Responses

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

RESPONSE BODY

total_count	integer (total_count) The total number of Resources present in the device. If a filter is applied, this is the total number of Resources that meet the criteria.
list_count	integer (list_count) Number of Lists to respond.
copysession_list	Array of objects (copysession) The information that can be retrieved with GET /copysession/{copysession_id} as the number specified for list_count is output. For more information, see "Responses" in Obtaining the Session Information.
next_href	string (next_href) Link to get more information. This item is returned only when it is not possible to respond all information at once. For example, this item is returned if there are more Resources that match with the response condition than the number specified by max_records.