Getting information about a specific ShadowImage 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 ShadowImage pair. This request can confirm whether a pair operation is finished based on the pair status, and can get configuration information such as the consistency group ID used when adding a pair.
Important:
  • If the target ShadowImage pair was created or deleted by using another REST API server or software other than the REST API, correct information about that pair might not be obtained. To obtain the most recent information about the pairs, use the API for obtaining a list of ShadowImage pairs.
  • If the copy group name, device group name, or copy pair name contains spaces, information cannot be obtained.

Execution permission

Storage Administrator (View Only)

Request line

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

Request message

Object ID

Specify the localCloneCopypairId value obtained by getting the ShadowImage pair information. You can also specify the following attributes and connect them with commas:

copyGroupName,pvolDeviceGroupName,svolDeviceGroupName,copyPairName

Attribute

Type

Description

copyGroupName

string

(Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.

pvolDeviceGroupName

string

(Required) Specify the P-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.

svolDeviceGroupName

string

(Required) Specify the S-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.

copyPairName

string

(Required) Specify the name of the copy pair. Value should not exceed 31 characters. The name is case sensitive.

Query parameters
None.
Body
None.

Response message

Body
{
  "localCloneCopypairId" : "localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_,pair1",
  "copyGroupName" : "localCopyGroup1",
  "copyPairName" : "pair1",
  "replicationType" : "SI",
  "copyMode" : "NotSnapshot",
  "copyProgressRate" : 100,
  "pvolLdevId" : 10,
  "pvolStatus" : "PAIR",
  "svolLdevId" : 20,
  "svolStatus" : "PAIR",
  "pvolMuNumber" : 0,
  "pvolProcessingStatus": "N",
  "svolProcessingStatus": "N"
}

Attribute

Type

Description

copyGroupName

string

Copy group name

copyPairName

string

Copy pair name

replicationType

string

Pair type

SI: ShadowImage

copyMode

string

Copy mode

Outputs NotSnapshot.

copyProgressRate

int

Copy progress rate (%)

This attribute is not output if no information can be obtained.

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.

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.

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

pvolProcessingStatus

string

Processing status of the pair

  • E: The expansion processing is in progress.
  • N: The expansion processing is not in progress.

The same value as that of svolProcessingStatus is output.

svolProcessingStatus

string

Processing status of the pair

  • E: The expansion processing is in progress.
  • N: The expansion processing is not in progress.

The same value as that of pvolProcessingStatus is output.

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/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_,pair1