Getting a list of ShadowImage pairs

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 obtains information about the ShadowImage pairs in a copy group specified by using query parameters. You can also update the pair information when you obtain information about ShadowImage pairs.

Important:

If the target copy group contains a ShadowImage pair that was created or deleted by using another REST API server or software other than the REST API, information about that pair might not be obtained. To obtain the most recent information about such pairs, run the API with refresh=true specified for the query parameter. Note that such processing takes time because the information about the pairs in the specified copy group is updated, and then information is obtained.
If the copy group name, device group name, or copy pair name contains spaces, the information cannot be obtained.

Execution permission

Storage Administrator (View Only)

Request line

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

Request message

Object ID: None.

Query parameters

Parameter	Type	Filter condition
localCloneCopyGroupId	string	(Required) Object ID of the copy group that contains a pair Specify the `localCloneCopygroupId` value obtained by getting the list of copy groups. You can also specify the following attributes separated by a comma: `copyGroupName`,`pvolDeviceGroupName`,`svolDeviceGroupName` copyGroupName (string) Copy group name Value should not exceed 31 characters. pvolDeviceGroupName (string) Device group name for the P-VOL Value should not exceed 31 characters. svolDeviceGroupName (string) Device group name for the S-VOL Value should not exceed 31 characters.
refresh	boolean	(Optional) Whether to update the pair information to the most recent: `true`: Pair information will be updated. `false`: Pair information will not be updated. If you specify `true`, processing takes time because the information about the pairs in the specified copy group is updated and then information is obtained. If this parameter is omitted, `false` is assumed.

Parameter

Type

Filter condition

localCloneCopyGroupId

string

(Required) Object ID of the copy group that contains a pair

Specify the localCloneCopygroupId value obtained by getting the list of copy groups. You can also specify the following attributes separated by a comma:

copyGroupName,pvolDeviceGroupName,svolDeviceGroupName

copyGroupName (string)
Copy group name

Value should not exceed 31 characters.
pvolDeviceGroupName (string)
Device group name for the P-VOL

Value should not exceed 31 characters.
svolDeviceGroupName (string)
Device group name for the S-VOL

Value should not exceed 31 characters.

refresh

boolean

(Optional) Whether to update the pair information to the most recent:

true: Pair information will be updated.
false: Pair information will not be updated.

If you specify true, processing takes time because the information about the pairs in the specified copy group is updated and then information is obtained. If this parameter is omitted, false is assumed.

Body: None.

Response message

Body: Information about the pairs in the specified copy group is obtained in a list. For details about the response body, see the section describing the API for obtaining information about specific ShadowImage pairs.

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-copypairs?localCloneCopyGroupId=localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_&refresh=true"