Getting information about a specific remote copy pair

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request gets information about the specified copy pair (TrueCopy, Universal Replicator, or global-active device). Use this information to get the information that is necessary for performing pair operations (for example, the pair status). If the copy group name or copy pair name contains spaces, pair information cannot be obtained.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/remote-mirror-copypairs/object-ID

Request message

Object ID

Specify the value of remoteMirrorCopyPairId that was obtained by the processing to get information about the remote copy group. You can also specify the attributes and connect them with commas as follows:

remoteStorageDeviceId,copyGroupName,localDeviceGroupName,remoteDeviceGroupName,copyPairName

Attribute

Type

Description

remoteStorageDeviceId

string

(Required) Storage device ID of the remote storage system #

Specify a decimal (base 10) number equal to or greater than 0.

copyGroupName

string

(Required) Copy group name

Specify a character string consisting of 1 to 31 characters. The name is case sensitive.

localDeviceGroupName

string

(Required) Device group name in the local storage system

Specify a character string consisting of 1 to 31 characters. The name is case sensitive.

remoteDeviceGroupName

string

(Required) Device group name in the remote storage system #

Specify a character string consisting of 1 to 31 characters. The name is case sensitive.

copyPairName

string

(Required) Copy pair name

Specify a name consisting of 1 to 31 characters. The name is case sensitive.

#: If you specify NotSpecified in cases such as when a failure occurs in a remote storage system, only information about the local storage system can be acquired. If you specify NotSpecified, copy pair information about attributes of volumes that belong to the remote storage system will not be output. In this case, you do not need to specify the Remote-Authorization header.

Query parameters

None.

Body

None.

Response message

Body

The following is an example of the output when information about TrueCopy pairs is obtained:

{
  "copyGroupName" : "remoteCopyGroup1",
  "copyPairName" : "pair1",
  "replicationType" : "TC",
  "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_,pair1",
  "pvolLdevId" : 2108,
  "svolLdevId" : 1581,
  "fenceLevel" : "DATA",
  "pvolStatus" : "PAIR",
  "svolStatus" : "PAIR",
  "pvolStorageDeviceId" : "886000123456",
  "svolStorageDeviceId" : "886000123789",
  "pvolDifferenceDataManagement": "S", 
  "svolDifferenceDataManagement": "S", 
  "pvolProcessingStatus": "N", 
  "svolProcessingStatus": "N" 
}

The following is an example of the output when information about Universal Replicator pairs is obtained:

{
  "copyGroupName" : "remoteCopyGroup2",
  "copyPairName" : "pair1",
  "replicationType" : "UR",
  "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_,pair1",
  "consistencyGroupId" : 10,
  "pvolLdevId" : 1569,
  "pvolJournalId" : 13,
  "svolLdevId" : 2835,
  "svolJournalId" : 36,
  "fenceLevel" : "ASYNC",
  "pvolStatus" : "PAIR",
  "svolStatus" : "PAIR",
  "pvolStorageDeviceId" : "886000123456",
  "svolStorageDeviceId" : "886000123789",
  "pvolDifferenceDataManagement": "S", 
  "svolDifferenceDataManagement": "S", 
  "pvolProcessingStatus": "N", 
  "svolProcessingStatus": "N" 
}

The following is an example of the output when information about global-active device pairs is obtained:

{
  "copyGroupName" : "remoteCopyGroup3",
  "copyPairName" : "pair1",
  "replicationType" : "GAD",
  "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_,pair1",
  "quorumDiskId" : 14,
  "pvolLdevId" : 1580,
  "svolLdevId" : 2128,
  "fenceLevel" : "NEVER",
  "pvolStatus" : "PAIR",
  "svolStatus" : "PAIR",
  "pvolIOMode" : "L/M",
  "svolIOMode" : "L/M",
  "pvolStorageDeviceId" : "886000123456",
  "svolStorageDeviceId" : "886000123789",
  "pvolDifferenceDataManagement": "S", 
  "svolDifferenceDataManagement": "S", 
  "pvolProcessingStatus": "N", 
  "svolProcessingStatus": "N" 
}

Attribute

Type

Description

copyGroupName

string

Copy group name

copyPairName

string

Copy pair name

replicationType

string

Pair type

  • TC: TrueCopy
  • UR: Universal Replicator
  • GAD: global-active device

If the pair status is SMPL, information is not output.

pvolLdevId

int

LDEV number of P-VOL

If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.

svolLdevId

int

LDEV number of S-VOL

If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.

fenceLevel

string

Fence level

  • DATA: S-VOL data
  • STATUS: S-VOL status
  • NEVER: None
  • ASYNC: Asynchronous

If the fence level cannot be obtained, information is not output.

pvolJournalId

int

Journal ID of the P-VOL

A value from 0 to 255 is output only in the case of UR. If the pair status is SMPL, information is not output.

If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.

svolJournalId

int

Journal ID of the S-VOL

A value from 0 to 255 is output only in the case of UR. If the pair status is SMPL, information is not output.

If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.

quorumDiskId

int

ID of the Quorum disk

A value from 0 to 31 is output only in the case of global-active device. If the pair status is SMPL, information is not output.

pvolStatus

string

Pair status of the P-VOL

For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).

If the pair status cannot be obtained, information is not output.

If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.

svolStatus

string

Pair status of the S-VOL

For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).

If the pair status cannot be obtained, information is not output.

If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.

consistencyGroupId

int

Consistency group ID

If no consistency group consists, information is not output.

pvolIOMode

string

I/O mode of the P-VOL

  • L/M: Mirror (RL)
  • L/L: Local
  • B/B: Block

Information is output only in the case of global-active device. If the pair status is SMPL, information is not output.

If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.

svolIOMode

string

I/O mode of the S-VOL

  • L/M: Mirror (RL)
  • L/L: Local
  • B/B: Block

Information is output only in the case of global-active device. If the pair status is SMPL, information is not output.

If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.

pvolStorageDeviceId

string

Storage device ID of the storage system on the P-VOL

If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.

svolStorageDeviceId

string

Storage device ID of the storage system on the S-VOL

If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.

copyProgressRate

int

Copy progress rate

Information is output only when the pair status of the P-VOL is COPY (a pair is being created or resynchronized).

This attribute is not output if you specify a value that includes NotSpecified for the object ID.

remoteMirrorCopyPairId

string

Object ID of the remote copy pair#

The following attributes are output, separated by commas:
  • remoteStorageDeviceId
  • copyGroupName
  • localDeviceGroupName
  • remoteDeviceGroupName
  • copyPairName

pvolDifferenceDataManagement

string

Method for managing difference data about the P-VOL

  • S: Difference data based on the shared memory
  • D: Hierarchical difference data (difference data based on drives)

svolDifferenceDataManagement

string

Method for managing difference data about the S-VOL

  • S: Difference data based on the shared memory
  • D: Hierarchical difference data (difference data based on drives)

pvolProcessingStatus

string

Processing status of the pair of P-VOLs

  • E: Processing to expand the P-VOLs is being performed
  • N: Processing to expand the P-VOLs is not being performed

svolProcessingStatus

string

Processing status of the pair of S-VOLs

  • E: Processing to expand the S-VOLs is being performed
  • N: Processing to expand the S-VOLs is not being performed

#: We recommend that you save the object ID information you obtain in case a failure occurs. When you need to perform a takeover to recover the system, you can use the saved information to identify the pair that you need to work on, even if you cannot get information about the failed storage system.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

For TrueCopy:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_,pair1

For Universal Replicator:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123789,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_,pair1

For global-active device:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123789,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_,pair1