Obtaining the Copy Session Information for All Volumes

GET /volume/copysession

Introduction

Obtains the Copy Session information for all volumes.

The information is sorted by volume_id in ascending order.

Caution

The presence of the following Copy Sessions is ignored in creating the response information. For example, is_copy_destination_volume is false for Copy destination Volumes in Storage Cluster.

  • Monitor

  • ODX

  • XCOPY

  • VVOL Copy Session

  • Storage Cluster

  • Copy Range is Extent

  • Copy Session Status is Reserved

Request Examples

  • This is an example of obtaining only the Volume ID and Name of a Copy Session.

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

Response Examples

{
  "total_count": 512,
  "list_count": 1,
  "volume_list": [
    {
      "volume_id": 100001,
      "volume_number": 1,
      "volume_href": "/api/v1/volume/100001",
      "volume_name": "vol#01",
      "is_copy_source_volume": true,
      "is_copy_destination_volume": true,
      "backup_type": "Clone",
      "source_volume_number": 2,
      "source_volume_href": "/api/v1/volume/200001",
      "source_volume_name": "datastore#2",
      "source_boxid": "00ETERNUSDXHS3ET00000A####EI000002######",
      "copysession_href": "/api/v1/copysession/1",
      "remote_copysession_id": 2,
      "backup_time": "2020-12-01T12:30:00Z",
      "error_ocurrence_time": "2020-12-01T12:30:00Z",
      "status": "Active",
      "phase": "Equivalent",
      "is_manual_snapshot": false,
      "is_data_tracking_disabled": false
    }
  ],
  "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 obtained.

For details about the specification methods, see Property Filter.
volume_id

Array of integers

Volume ID.

Specify the Volume ID for which you want information.

Input criteria:

  • You can specify up to 256 values.
is_copy_source_volume

boolean

Whether the Volume is the source Volume.

If true, only the information on the Volumes that are the Copy source in a Copy Session is responded.
is_copy_destination_volume

boolean

Whether the Volume is the destination Volume.

If true, only the information on the Volumes that are the Copy destination in a Copy Session is responded.
backup_type

Array of strings

Backup Type.

Specify the Volume Backup Type for which you want information.
Item Description
Clone The OPC or QuickOPC destination.
Snapshot SnapOPC or SnapOPC+ destination.
Local_Mirror EC destination.
Remote_Mirror REC destination.
Restored Destination for the Restore OPC (Except Restore OPC from PC destination).

Input criteria:

  • You can specify up to 5 values.
status

Array of strings

Status.

Specify the Volume Copy Session Status for which you want information.
Item Description
Active Operating normally.
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.
phase

Array of strings

Phase.

Specify the Volume Copy Session Phase for which you want information.
Item Description
Copying

  • Indicates that a copy is being performed if the volume backup type is Snapshot, Clone (physical data cannot be resynchronized), or Restored.

  • In the case of Clone (Physical data can be resynchronized), this phase indicates the recording of the update part has been stopped and the recorded update part is being copied.

  • For Local Mirror or Remote Mirror (Transfer mode is synchronous or asynchronous Consistency), this phase indicates data integrity is not guaranteed because data copying is in progress or data copying is being forced to be suspended.

  • For Remote Mirror (Transfer mode is asynchronous Stack), this phase indicates that the destination Volume data is inconsistent with the source Volume data.
Equivalent

  • For Local Mirror or Remote Mirror (Transfer mode is synchronous or asynchronous stack), this phase indicates the data matches with the Copy Source Volume and data integrity is guaranteed.

  • For Remote Mirror (Transfer mode is asynchronous Consistency), this phase indicates that data integrity is guaranteed (if there is any untransferred data in the REC Buffer, the data does not match with the Copy Source data).
Tracking After copying is completed with Clone (Physical data can be resynchronized), only the update part is being recorded.
Tracking_and_Copying Clone (Physical data can be resynchronized) is in the process of copying and is recording updates since the start of copying.
Readying Preparing to start copy.

Input criteria:

  • You can specify up to 5 values.
is_manual_snapshot

boolean

Whether the Snapshot is managed by generation.

If specified as true, only copy session information for snapshots not managed by generation (equivalent to SnapOPC Volumes) will be returned.
is_data_tracking_disabled

boolean

Whether the Clone's physical data can be resynchronized.

If specified as true, only the Copy Session information for Clones (equivalent to OPC Volumes) whose physical data cannot be resynchronized will be responded to.
max_records

integer

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

integer

Default: 0

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

integer

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

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

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

Responses

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

RESPONSE BODY

total_count

integer

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

Number of Lists to respond.
volume_list
Array of objects
volume_id

integer

Volume ID.
volume_number

integer

Volume Number.
volume_href

string

Link to Volume Resource.
volume_name

string

A Volume Friendly Name.
is_copy_source_volume

boolean

Whether the Volume is the source Volume.

If true, Volume is the source Volume.

If false, the Volume is not the source Volume.
is_copy_destination_volume

boolean

Whether the Volume is the destination Volume.

If true, Volume is the destination Volume.

If false, the Volume is not the destination Volume.
backup_type

string

Backup Type.

Respond only if Volume is the destination.
Item Description
Clone The OPC or QuickOPC destination.
Snapshot SnapOPC or SnapOPC+ destination.
Local_Mirror EC destination.
Remote_Mirror REC destination.
Restored Destination for the Restore OPC (Except Restore OPC from OPC destination).

The Volume Backup Type during a restore responds as follows.

  • If a Volume is being restored from Snapshot or Clone (excluding Clones whose physical data cannot be resynchronized), the Backup Type will respond with "Restored".

  • If the Volume is being restored from a Clone whose physical data cannot be resynchronized, the Backup Type will respond with "Clone".

  • If a Volume is being restored from Remote Mirror or Local Mirror using the Reverse Copy Session feature, the Backup Type will respond "Remote Mirror" or "Local Mirror".
source_volume_number

integer

Number of the source Volume.

Respond only if Volume is the destination.

If the Backup Type is Restored, the Number of the Volume from which to restore is responded with.

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.

Respond only if Volume is the destination.

It will not respond if the Backup Type is Remote_Mirror.

If the Backup Type is Restored, a Link to the Resource in the Volume from which to restore is responded with.

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.

Respond only if Volume is the destination.

It will not respond if the Backup Type is Remote_Mirror.

If the Backup Type is Restored, the Friendly Name of the Volume from which to restore is responded with.

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

string

The Box ID of the copy source device.

Respond only if Volume is the destination.

This item is returned only if Backup Type is Remote_Mirror.
copysession_href

string

Resource link of the Copy Session.

Respond only if Volume is the destination.
remote_copysession_id

integer

The Copy Session ID of the destination device.

Respond only if Volume is the destination.

This item is returned only if Backup Type is Remote_Mirror.
backup_time

string

The backup start time for the Copy Session.

Respond only if Volume is the destination.

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

If the Backup Type is Restored, the start time of the data copy from the restore source Volume in the background is responded to.

Format is as follows:

The time zone is UTC.

YYYY-MM-DDThh:mm:ssZ
error_ocurrence_time

string

Time the Copy Session failed.

Respond only if Volume is the destination.

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
status

string

Copy Session status.

Respond only if Volume is the destination.
Item Description
Active Operating normally.
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.
phase

string

Phase of the Copy Session.

Respond only if Volume is the destination.

If Backup Type is Clone, the phases that can be responded are Copying, Tracking, Tracking_and_Copying, and Reading.

If Backup Type is Snapshot or Restored, the phases that can be responded are Copying and Reading.

If Backup Type is Local_Mirror or Remote_Mirror, the phases that can be responded are Copying and Equivalent.
Item Description
Copying

  • Indicates that a copy is being performed if the volume backup type is Snapshot, Clone (physical data cannot be resynchronized), or Restored.

  • In the case of Clone (Physical data can be resynchronized), this phase indicates the recording of the update part has been stopped and the recorded update part is being copied.

  • For Local Mirror or Remote Mirror (Transfer mode is synchronous or asynchronous Consistency), this phase indicates data integrity is not guaranteed because data copying is in progress or data copying is being forced to be suspended.

  • For Remote Mirror (Transfer mode is asynchronous Stack), this phase indicates that the destination Volume data is inconsistent with the source Volume data.
Equivalent

  • For Local Mirror or Remote Mirror (Transfer mode is synchronous or asynchronous stack), this phase indicates the data matches with the Copy Source Volume and data integrity is guaranteed.

  • For Remote Mirror (Transfer mode is asynchronous Consistency), this phase indicates that data integrity is guaranteed (if there is any untransferred data in the REC Buffer, the data does not match with the Copy Source data).
Tracking After copying is completed with Clone (Physical data can be resynchronized), only the update part is being recorded.
Tracking_and_Copying Clone (Physical data can be resynchronized) is in the process of copying and is recording updates since the start of copying.
Readying Preparing to start copy.
is_manual_snapshot

boolean

Whether the Snapshot is managed by generation.

Respond only if Volume is the destination.

If true, the Snapshot is not managed by generation (equivalent to SnapOPC Sessions).

If false, the Snapshot is managed by generation (equivalent to SnapOPC+ Sessions).

It is also false for Volumes other than Snapshot.
is_data_tracking_disabled

boolean

Whether the Clone's physical data can be resynchronized.

Respond only if Volume is the destination.

This property is returned only if backup_type is Clone.

If true, the Clone's physical data cannot be resynchronized (equivalent to OPC Session).

If false, the Clone's physical data can be resynchronized (equivalent to QuickOPC Session).
next_href

string

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 the response condition than the number specified by max_records.