Getting information about all of Thin Image 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 Thin Image 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 snapshot 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/snapshot-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": [
        {
            "snapshotReplicationId": "20900,3",
            "pvolLdevId": 20900,
            "svolLdevId": 20904,
            "snapshotPoolId": 103,
            "status": "PAIR",
            "concordanceRate": 100,
            "muNumber": 3,
            "isClone": false,
            "canCascade": false
        },
        {
            "snapshotReplicationId": "20912,3",
            "pvolLdevId": 20912,
            "svolLdevId": 20905,
            "snapshotPoolId": 104,
            "status": "PAIR",
            "concordanceRate": 90,
            "muNumber": 3,
            "isClone": false,
            "canCascade": false
        },
        {
            "snapshotReplicationId": "20912,4",
            "pvolLdevId": 20912,
            "svolLdevId": 20906,
            "snapshotPoolId": 104,
            "status": "PAIR",
            "concordanceRate": 80,
            "muNumber": 4,
            "isClone": false,
            "canCascade": false
        }
    ]
}

Attribute

Type

Description

snapshotReplicationId

string

Object ID of the Thin Image pair

The following attributes are output, separated by commas:

  • pvolLdevId
  • muNumber

snapshotGroupName

string

Name of the snapshot group

This attribute is output if the target pair belongs to a snapshot group.

pvolLdevId

int

LDEV number of P-VOL

snapshotPoolId

int

ID of the pool in which the snapshot data was created

svolLdevId

int

LDEV number of S-VOL

This attribute is displayed if the target pair is a Thin Image pair that has an S-VOL.

status

string

Pair status

  • SMPP
  • COPY
  • PAIR
  • PSUS
  • PFUL
  • PSUE
  • PFUS
  • RCPY
  • PSUP
  • OTHER

consistencyGroupId

int

Consistency group ID

If no consistency group consists, information is not output.

concordanceRate

int

Concordance rate for pairs

muNumber

int

MU number of the P-VOL

splitTime

string

Time when snapshot data was created

The local time of the storage system is returned in YYYY-MM-DDThh:mm:ss format.

This attribute is output if the pair status is PSUS or PSUP.

isClone

boolean

Returns whether the pair has the clone attribute.

  • true: The pair has the clone attribute.
  • false: The pair does not have the clone attribute.

canCascade

boolean

Returns whether the pair can be a cascaded pair.

  • true: The pair that is or can be used in a cascade configuration.
  • false: The pair cannot be a cascaded pair.

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/snapshot-replications