Getting information about Thin Image pairs in units of snapshot 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 a list of information about Thin Image pairs in units of snapshot groups. Use this information to check the information that is necessary for performing pair operations (for example, the pair status).

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/snapshot-groups

Request message

Object ID

None.

Query parameters

You can get a list of information about pairs in a snapshot group, as well as detailed information about a pair in a snapshot group.

Parameter

Type

Description

snapshotGroupName

string

(Optional) Specify the name of the snapshot group that contains the Thin Image pairs.

Specify a character string consisting of 1 to 32 characters.

Specify this parameter to get a list of information about pairs in the target snapshot group.

If this parameter is omitted, this request gets a list of snapshot groups.

You cannot specify both this parameter and the detailInfoType parameter.

detailInfoType

string

(Optional) Type of detailed information to be obtained

  • pair

    Gets detailed information about the pairs in each snapshot group in addition to a list of snapshot 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".

You cannot specify both this parameter and the snapshotGroupName parameter.

Body

None.

Response message

Body

The following is an example of the output generated when getting a list of snapshot groups:

{
  "data": [
    {
      "snapshotGroupName": "snapshotGroup",
      "snapshotGroupId": "snapshotGroup"
    },
    {
      "snapshotGroupName": "snapshotGroup2",
      "snapshotGroupId": "snapshotGroup2"
    }
  ]
}

Attribute

Type

Description

snapshotGroupName

string

Name of the snapshot group that contains the Thin Image pairs.

If the name of the snapshot group contains spaces, information about that snapshot group is not output.

snapshotGroupId

string

Object ID of the snapshot group.

The following is an example of the output when the request for getting a list of information about pairs in a snapshot group is executed with snapshotGroupName specified as the query parameter. If multiple pairs exist, the information is output in ascending order of the LDEV number and MU number of the primary volume.

{
  "data": [
    {
      "snapshotGroupName": "snapshotGroup",
      "primaryOrSecondary": "P-VOL",
      "status": "PSUS",
      "pvolLdevId": 100,
      "muNumber": 3,
      "svolLdevId": 101,
      "snapshotPoolId": 10,
      "concordanceRate": 100,
      "isConsistencyGroup": true,
      "isWrittenInSvol": false,
      "isClone": false,
      "canCascade": false,
      "splitTime": "2015-03-20T09:27:35",
      "snapshotId": "100,3",
      "pvolProcessingStatus": "N",
      "snapshotDataReadOnly": false
    },
    {
      "snapshotGroupName": "snapshotGroup",
      "primaryOrSecondary": "P-VOL",
      "status": "PSUS",
      "pvolLdevId": 100,
      "muNumber": 4,
      "snapshotPoolId": 10,
      "concordanceRate": 100,
      "isConsistencyGroup": true,
      "isWrittenInSvol": false,
      "isClone": false,
      "canCascade": false,
      "splitTime": "2015-03-20T09:27:35",
      "snapshotId": "100,4",
      "pvolProcessingStatus": "N",
      "snapshotDataReadOnly": false
    }
  ]
}

Attribute

Type

Description

snapshotGroupName

string

Name of the snapshot group that contains the Thin Image pairs.

If the name of the snapshot group contains spaces, information about pairs is not output.

primaryOrSecondary

string

Attribute of the LDEV

status

string

Pair status

For details, see the section explaining on pair status (Thin Image).

pvolLdevId

int

LDEV number of P-VOL

muNumber

int

MU number of the P-VOL

svolLdevId

int

LDEV number of S-VOL

snapshotPoolId

int

ID of the pool in which the snapshot data is created

concordanceRate

int

Concordance rate for pairs

This attribute is output when either of the following conditions is met:

  • The value of the isClone attribute is false, and the value of the canCascade attribute is also false.
  • The value of either the isClone attribute or the canCascade attribute is true, and the value of the status attribute is not any of the following: COPY, RCPY, SMPP, or PSUP.

progressRate

int

Progress of the processing

This attribute is output when the following condition is met:

The value of either the isClone attribute or the canCascade attribute is true, and the value of the status attribute is one of the following: COPY, RCPY, SMPP, or PSUP.

isConsistencyGroup

boolean

Returns whether the pair was created in the consistency group mode (CTG mode).

  • true: The pair was created in the CTG mode.
  • false: The pair was not created in the CTG mode.

isWrittenInSvol

boolean

Returns whether data was written to the S-VOL from the host when the pair status was PSUS/PFUS.

  • true: Data was written to the S-VOL
  • false: Data was not written to the S-VOL

If the target pair is a Thin Image pair that does not have an S-VOL, false is displayed.

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 can be a cascaded pair.
  • false: The pair cannot be a cascaded pair.

splitTime

string

Time when snapshot data was created

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

snapshotId

string

Object ID of the Thin Image pair

The following attributes are output, separated by commas:
  • pvolLdevId
  • muNumber

pvolProcessingStatus

string

Processing status of the pair

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

This attribute is output when the value of the primaryOrSecondary attribute is P-VOL.

svolProcessingStatus

string

Processing status of the pair

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

This attribute is output when the value of the primaryOrSecondary attribute is S-VOL.

snapshotDataReadOnly

boolean

Returns whether the snapshot data is a pair that has the read-only attribute

  • true: Read-only
  • false: Not read-only

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 snapshot groups. If multiple pairs exist, the information is output in ascending order of the LDEV number and MU number of the primary volume.

Attribute

Type

Description

snapshots

object[]

Outputs the following attributes related to Thin Image pairs contained in the snapshot group.

  • snapshotGroupName (string)

    Name of the snapshot group

  • status (string)

    Pair status

    For details, see the section explaining on pair status (Thin Image).

  • pvolLdevId (int)

    LDEV number of P-VOL

  • muNumber (int)

    MU number of the P-VOL

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

  • snapshotPoolId (int)

    ID of the pool in which the snapshot data is created

  • concordanceRate (int)

    Concordance rate for pairs

    This attribute is displayed if the pair status is not SMPL.

  • isConsistencyGroup (boolean)

    Returns whether the pair was created in the consistency group mode (CTG mode).

    • true: The pair was created in the CTG mode.
    • false: The pair was not created in the CTG mode.
  • isWrittenInSvol (boolean)

    Returns whether data was written to the S-VOL from the host when the pair status was PSUS/PFUS.

    • true: Data was written to the S-VOL
    • false: Data was not written to the S-VOL

    If the target pair is a Thin Image pair that does not have an S-VOL, false is displayed.

  • 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 can be a cascaded pair.
    • false: The pair cannot be a cascaded pair.
  • splitTime (string)

    Time when snapshot data was created

    This attribute is displayed if the pair status is PSUS, PFUS, or PSUP.

    The storage system time in Greenwich Mean Time (GMT) is displayed in the YYYY-MM-DDThh:mm:ss format.

  • snapshotId (string)

    Object ID of the Thin Image pair

    The following attributes are output, separated by commas:

    • pvolLdevId
    • muNumber

Status codes

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