Getting information about a specific remote copy group

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 group. This request also gets information about the pairs (TrueCopy, Universal Replicator, or global-active device) included in the copy group. 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-copygroups/object-ID

Request message

Object ID

Specify the value of remoteMirrorCopyGroupId 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

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.

#: 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

Parameter

Type

Description

detailInfoType

string

(Optional) Type of detailed information to be obtained

  • class

    Adds additional information# from the storage system's cache.

    You can specify this item for VSP 5000 series.

    To get up-to-date information, you must run the API request that refreshes the storage system's cache before running this request. For details, see "Updating the cache of storage system configuration information".

#: If the remote storage system is a VSP E series, VSP G350, G370, G700, G900 or VSP F350, F370, F700, F900 model storage system, you might not be able to get some of the information about the remote storage system.

For other storage systems, if the remote storage system's microcode version meets the following conditions, you might not be able to get some of the information about the remote storage system.

  • For a VSP 5000 series storage system:

    The microcode version is earlier than 90-01-42-XX/XX.

  • For a VSP G1000, VSP G1500, VSP F1500 model storage system:

    The microcode version is earlier than 80-06-71-XX/XX.

Body

None.

Response message

Body

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

{
  "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_",
  "copyGroupName" : "remoteCopyGroup1",
  "copyPairs" : [ {
    "copyGroupName" : "remoteCopyGroup1",
    "copyPairName" : "pair1",
    "replicationType" : "TC",
    "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_,pair1",
    "pvolLdevId" : 2108,
    "svolLdevId" : 1581,
    "fenceLevel" : "DATA",
    "pvolStatus" : "PAIR",
    "svolStatus" : "PAIR",
    "consistencyGroupId": 5,
    "pvolStorageDeviceId" : "886000123456",
    "svolStorageDeviceId" : "886000123789",
    "pvolDifferenceDataManagement": "S",
    "svolDifferenceDataManagement": "S",
    "pvolProcessingStatus": "N",
    "svolProcessingStatus": "N"
  }, {
    "copyGroupName" : "remoteCopyGroup1",
    "copyPairName" : "pair2",
    "replicationType" : "TC",
    "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_,pair2",
    "pvolLdevId" : 2109,
    "svolLdevId" : 1582,
    "fenceLevel" : "DATA",
    "pvolStatus" : "PSUS",
    "svolStatus" : "SMPL",
    "consistencyGroupId": 5,
    "pvolStorageDeviceId" : "886000123456",
    "svolStorageDeviceId" : "886000123789",
    "pvolDifferenceDataManagement": "S",
    "svolDifferenceDataManagement": "S",
    "pvolProcessingStatus": "N",
    "svolProcessingStatus": "N"
  } ],
  "remoteStorageDeviceId" : "886000123789",
  "localDeviceGroupName" : "remoteCopyGroup1P_",
  "remoteDeviceGroupName" : "remoteCopyGroup1S_"
}

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

{
  "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_",
  "copyGroupName" : "remoteCopyGroup2",
  "copyPairs" : [ {
    "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"
  } ],
  "remoteStorageDeviceId" : "886000123789",
  "localDeviceGroupName" : "remoteCopyGroup2P_",
  "remoteDeviceGroupName" : "remoteCopyGroup2S_"
}

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

{
  "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_",
  "copyGroupName" : "remoteCopyGroup3",
  "copyPairs" : [ {
    "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"
  } ],
  "remoteStorageDeviceId" : "886000123789",
  "localDeviceGroupName" : "remoteCopyGroup3P_",
  "remoteDeviceGroupName" : "remoteCopyGroup3S_"
}

Attribute

Type

Description

remoteStorageDeviceId

string

Storage device ID of the remote storage system

If you specify a value that includes NotSpecified for the object ID, NotSpecified is output.

copyGroupName

string

Copy group name

localDeviceGroupName

string

Device group name in the local storage system

remoteDeviceGroupName

string

Device group name in the remote storage system

If you specify a value that includes NotSpecified for the object ID, NotSpecified is output.

remoteMirrorCopyGroupId

string

Object ID of the remote copy group

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

copyPairs

object[]

The detailed information about the copy pair is output.

  • 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 Universal Replicator. 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 Universal Replicator. 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.

If you run this request with class specified for detailInfoType in the query parameters, additional information from the storage system's cache is also obtained.

Attribute

Type

Description

copyPairs

object[]

Attributes related to the detailed information about the copy pair

  • transitionStatus (string)

    The transition status of a pair is output for a Universal Replicator pair.

    • None: The pair is not in transition.
    • Suspending: The pair is being split.
    • Deleting: The pair is being deleted.

    This is not output if the copy pair is not a Universal Replicator pair.

  • copyPace (int)

    Copy speed

    This is not output for a Universal Replicator pair.

  • pathGroupId (int)

    ID of the RCU path group

    This is not output if CU is specified for the remote path connection setting.

    This is not output if the pair volume status of the P-VOL or S-VOL (the value of the pvolStatus attribute of the svolStatus attribute) is SMPL.

  • deltaStatus (string)

    Status of the 3DC multi-target configuration that uses delta resync

    This is output if the value of replicationType for the copyPairs attribute of the replicationType attribute, which is the pair type for the detailed information about the remote copy pairs, is Universal Replicator, and if you are using a 3DC multi-target configuration that uses delta resync.

    • HOLD: Universal Replicator delta resync pair (normal)
    • HLDE: Universal Replicator delta resync pair (failed)
    • HOLDING: In the process of being changed to a Universal Replicator delta resync pair

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-copygroups/886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_

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-copygroups/886000123789,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_

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-copygroups/886000123789,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_
Related reference