Getting a list of 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 information about the copy groups containing ShadowImage pairs in the storage system.
Important:

If the copy group name or device group name contains spaces, the copy group information cannot be obtained.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/local-clone-copygroups

Request message

Object ID
None.
Query parameters

Parameter

Type

Description

detailInfoType

string

(Optional) Type of detailed information to be obtained

  • pair

    Specify this parameter to get detailed information about the pairs in each copy group in addition to a list of copy groups.

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

Body
None.

Response message

Body
{
  "data": [
    {
      "copyGroupName": "localCopyGroup1",
      "pvolDeviceGroupName": "localCopyGroup1P_",
      "svolDeviceGroupName": "localCopyGroup1S_",
      "localCloneCopygroupId": "localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_"
    },
    {
      "copyGroupName": "localCopyGroup2",
      "pvolDeviceGroupName": "localCopyGrouppvol",
      "svolDeviceGroupName": "localCopyGroupsvol",
      "localCloneCopygroupId": "localCopyGroup2,localCopyGrouppvol,localCopyGroupsvol"
    }
  ]
}

Attribute

Type

Description

copyGroupName

string

Copy group name

pvolDeviceGroupName

string

Device group name for the P-VOL

svolDeviceGroupName

string

Device group name for the S-VOL

localCloneCopygroupId

string

Object ID of the copy group that contains a ShadowImage pair

The following attributes are output, separated by commas:

  • copyGroupName
  • pvolDeviceGroupName
  • svolDeviceGroupName

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

Attribute

Type

Description

copyPairs

object[]

The following attributes about the ShadowImage pairs included in the copy group:

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

    Outputs SI (ShadowImage).

  • copyMode (string)#

    Copy mode

    Outputs NotSnapshot.

  • pvolLdevId (int)

    LDEV number of the P-VOL

  • svolLdevId (int)

    LDEV number of the S-VOL

  • pvolMuNumber (int)

    MU number of the P-VOL

  • pvolStatus (string)#

    Pair volume status of the P-VOL

    For details, see the section describing the pair status (ShadowImage).

    This attribute is not output if no information can be obtained or if the status of the ShadowImage pair in transition is Deleting.

  • svolStatus (string)#

    Pair volume status of the S-VOL

    For details, see the section describing the pair status (ShadowImage).

    This attribute is not output if no information can be obtained or if the status of the ShadowImage pair in transition is Deleting.

  • consistencyGroupId (int)

    Consistency group ID

    This attribute is not output if no consistency group consists.

  • localCloneCopypairId (string)

    Object ID of the ShadowImage pair

    The following attributes are output, separated by commas:

    • copyGroupName
    • pvolDeviceGroupName
    • svolDeviceGroupName
    • copyPairName
  • transitionStatus (string)

    The status of the ShadowImage pair in transition

    • None: The pair is not in transition

    • Deleting: The pair is being deleted

#: Immediately after the ShadowImage pair is created, pair information might be output as follows:
  • The copyMode attribute is NotSynchronized.
  • The pvolStatus attribute is SMPL.
  • The svolStatus attribute is SMPL.

If this occurs, either run the API again after execution of the API for updating the cache of the storage system configuration information is complete, or run the API for getting information about specific copy groups to get correct information.

Status codes

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

Coding example

curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copygroups