Getting a list of remote copy groups

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 a list of all the remote copy groups in which the remote copy pairs (TrueCopy, Universal Replicator, and global-active device) of the target storage system are registered. If the device group name or copy group name contains single-byte spaces, copy group information cannot be obtained.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/remote-mirror-copygroups

Request message

Object ID

None.

Query parameters

You can get only a list of remote copy groups, or you can get detailed information about remote copy pairs in addition to a list of remote copy groups.

  • To get a list of remote copy groups only:

    Parameter

    Type

    Filter condition

    remoteStorageDeviceId

    string

    (Required) Storage device ID of the remote storage system

    If a failure occurs in a remote storage system and you then specify NotSpecified, only the information about the local storage system is obtained. In this situation (when a failure occurs and you specify NotSpecified), you do not need to specify the Remote-Authorization header.

    If you specify NotSpecified for this parameter, you cannot specify the detailInfoType parameter.

  • To obtain additional detailed information:

    Parameter

    Type

    Description

    detailInfoType

    string

    (Optional) Type of detailed information to be obtained

    • pair

      Gets additional detailed information# about remote copy pairs.

      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 you specify NotSpecified for the remoteStorageDeviceId parameter, you cannot specify this parameter.

    #: 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
{
  "data" : [ {
    "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup1,remoteCopyGroup1S_,remoteCopyGroup1P_",
    "copyGroupName" : "remoteCopyGroup1",
    "muNumber" : 0,
    "remoteStorageDeviceId" : "886000123789",
    "localDeviceGroupName" : "remoteCopyGroup1S_",
    "remoteDeviceGroupName" : "remoteCopyGroup1P_"
  }, {
    "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_",
    "copyGroupName" : "remoteCopyGroup2",
    "muNumber" : 0,
    "remoteStorageDeviceId" : "886000123789",
    "localDeviceGroupName" : "remoteCopyGroup2P_",
    "remoteDeviceGroupName" : "remoteCopyGroup2S_"
  }, {
    "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_",
    "copyGroupName" : "remoteCopyGroup3",
    "muNumber" : 0,
    "remoteStorageDeviceId" : "886000123789",
    "localDeviceGroupName" : "remoteCopyGroup3P_",
    "remoteDeviceGroupName" : "remoteCopyGroup3S_"
  } ]
}

Attribute

Type

Description

remoteStorageDeviceId

string

Storage device ID of the remote storage system

If you specify NotSpecified for remoteStorageDeviceId, 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 NotSpecified for remoteStorageDeviceId, NotSpecified is output.

muNumber

int

MU (mirror unit) number

If the MU number cannot be obtained, information is not output.

remoteMirrorCopyGroupId

string

Object ID of the remote copy group

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

If you run the request with pair specified for the query parameter detailInfoType, you can get the following information, in addition to information about remote copy groups:

Attribute

Type

Description

copyPairs

object[]

Detailed information about the remote copy pair is output.

If information cannot be acquired, the attributes under the copyPairs object are not 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

  • svolLdevId (int)

    LDEV number of S-VOL

  • 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. This information is not output if the pair type cannot be obtained.

  • svolJournalId (int)

    Journal ID of the S-VOL

    A value from 0 to 255 is output only in the case of Universal Replicator. This information is not output if the pair type cannot be obtained.

  • quorumDiskId (int)

    ID of the Quorum disk

    A value from 0 to 31 is output only in the case of global-active device. This information is not output if the pair type cannot be obtained.

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

    In the case of Universal Replicator, if the transition status of the Universal Replicator pair is Suspending or Deleting, information is not output.

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

    In the case of Universal Replicator, if the transition status of the Universal Replicator pair is Suspending or Deleting, information is not output.

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

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

  • pvolStorageDeviceId (string)

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

  • svolStorageDeviceId (string)

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

  • remoteMirrorCopyPairId (string)

    Object ID of the remote copy pair

    The following attributes are output, separated by commas:
    • remoteStorageDeviceId
    • copyGroupName
    • localDeviceGroupName
    • remoteDeviceGroupName
    • copyPairName
  • 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 if copy pair is Universal Replicator.

  • 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 status of the P-VOL or the S-VOL is SMPL.

  • deltaStatus (string)

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

    This is output if the pair type is Universal Replicator and the 3DC multi-target configuration that uses delta resync is used.

    • 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

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?remoteStorageDeviceId=886000123789