Getting information about all 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 gets information about the ShadowImage pairs registered in the target storage system. You can obtain information about all such pairs from the cache of the storage system, regardless of whether they are managed by using copy groups.
Note:
  • This API can be used when the storage system is the 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".

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/local-replications

Request message

Object ID
None.
Query parameters

Parameter

Type

Description

startPvolLdevId

int

(Optional) To specify a range of LDEVs, specify the LDEV number of the first LDEV in the range.

The P-VOLs in the specified range of LDEVs are searched, and information about the relevant pairs is obtained.

Specify a value in the range from 0 to 65279.

The value of this parameter must be smaller than that of the endPvolLdevId parameter.

If this attribute is omitted, 0 is set.

endPvolLdevId

int

(Optional) To specify a range of LDEVs, specify the LDEV number of the last LDEV in the range.

The P-VOLs in the specified range of LDEVs are searched, and information about the relevant pairs is obtained.

Specify a value in the range from 0 to 65279.

The value of this parameter must be greater than that of the startPvolLdevId parameter.

If this attribute is omitted, the maximum LDEV number in the storage system is set.

Body
None.

Response message

Body
{
    "data": [
        {
            "localReplicationId": "474,475",
            "replicationType": "SI",
            "copyMode": "NotSnapshot",
            "pvolLdevId": 474,
            "svolLdevId": 475,
            "pvolMuNumber": 0,
            "pvolStatus": "PAIR",
            "svolStatus": "PAIR",
            "consistencyGroupId": -1,
            "transitionStatus": "None"
        },
        {
            "localReplicationId": "476,487",
            "replicationType": "SI",
            "copyMode": "NotSnapshot",
            "pvolLdevId": 476,
            "svolLdevId": 487,
            "pvolMuNumber": 0,
            "pvolStatus": "PAIR",
            "svolStatus": "PAIR",
            "consistencyGroupId": -1,
            "transitionStatus": "None"
        }
    ]
}

Attribute

Type

Description

localReplicationId

string

Object ID of the copy pair

The following attributes are output, separated by commas:

  • pvolLdevId
  • svolLdevId

replicationType

string

Pair type

Outputs SI (ShadowImage).

copyMode

string

Copy mode

For ShadowImage, NotSnapshot is output.

If Volume Migration operations have already been performed for the pair, VolumeMigration is output.

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.

transitionStatus

string

The status of the ShadowImage pair in transition

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

Status codes

For details on the status codes for the request that performs this operation, see the description of 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-replications