Getting information about a specific snapshot group

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/snapshot-groups/object-ID

Request message

Object ID

Specify a value for the name that was obtained by getting the list of snapshot group names.

Attribute	Type	Description
name	string	(Required) Snapshot group name

Note:

Do not specify the following snapshot group names:

• Names that include a slash (/) or backslash (\)
• Names consisting of only a period (.)

You can get information about these snapshot groups by running the API request for getting snapshot information with the query parameter snapshotGroupName specified.

Query parameters

With each request, you can obtain information for a maximum of 1000 snapshot groups. To get information about 1,001 or more snapshots, run the API request multiple times, using the count and startSnapshotId parameters to split the snapshots among the requests. By specifying the count parameter, you can also filter the snapshots to obtain.

Parameter	Type	Filter Condition
startSnapshotId	string	(Optional) Specify the ID of the snapshot from which to obtain information. If this parameter is omitted, "0,0" is assumed.
count	int	(Optional) Specify the number of snapshots for which information is to be obtained as a number in the range from 1 to 1000. If this parameter is omitted, 1000 is assumed.

Body

None.

Response message

Body

The following is an example of the output when getting information about the snapshot group with the name snapshotGroup:

{
  "name": "snapshotGroup",
  "snapshots": [
    {
      "masterVolumeId": 100,
      "snapshotId": 3
    },
    {
      "masterVolumeId": 100,
      "snapshotId": 4
    }
  ],
  "count": 2,
  "totalCount": 2,
  "hasNext": false
}

Attribute	Type	Description
name	string	Snapshot group name
snapshots	object[]	The following information about the snapshot is obtained: masterVolumeId (int) Master volume ID of the snapshot snapshotId (int) Snapshot ID The mirror unit number is obtained.
count	int	Number of snapshots for which information is obtained
totalCount	int	Total number of snapshots in the snapshot group
hasNext	boolean	Whether there is information that could not be obtained true: There is information that could not be obtained. false: All information was obtained. If there is information that could not be obtained, specify query parameters to filter for the information to be obtained. Alternatively, to get information about the snapshots after the last snapshot for which information was obtained, run the API request multiple times, splitting the remaining snapshots among the requests.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/snapshot-groups/snapshotGroup