Getting snapshot information

Storage Advisor Embedded User Guide

Version
93-07-2x
88-08-12
Audience
anonymous
Part Number
MK-97HM85022-25

The following request gets information about snapshots. You can specify filter conditions.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/snapshots

Request message

Object ID
None.
Query parameters

With each request, you can obtain information for a maximum of 1000 snapshots. To obtain information for more than 1000 snapshots, run the API request several times by using a combination of the count and startId parameters. By specifying the count parameter, you can also filter the snapshot information.

Parameter

Type

Filter Condition

masterVolumeId

int

(Optional) Master volume ID of the snapshot

snapshotDateFrom

ISO8601string

(Optional) Specify the date and time from which snapshots will be obtained, in YYYY-MM-DDThh:mm:ssZ format.

Information about snapshots created on and after the date and time specified for this parameter will be obtained.

snapshotDateTo

ISO8601string

(Optional) Specify the date and time until which snapshots will be obtained, in YYYY-MM-DDThh:mm:ssZ format.

Information about snapshots created on and before the date and time specified for this parameter will be obtained.

snapshotGroupName

string

(Optional) Snapshot group name

Information about the snapshot that is a perfect match with the specified value is obtained.

startId

string

(Optional) Specify the first snapshot information to obtain, by specifying the master volume ID of the snapshot and the snapshot ID, linked by a comma.

masterVolumeId,snapshotId

If this parameter is omitted, "0,0" is assumed.

count

int

(Optional) Specify the number of snapshots by using a value in the range from 1 through 1000.

If this parameter is omitted, 1000 is considered.

Body
None.

Response message

Body
{
  "data": [
    {
      "id": "100,3",
      "masterVolumeId": 100,
      "snapshotId": 3,
      "status": "Completed",
      "snapshotDate": "2015-03-20T09:27:35Z",
      "snapshotGroupName": "snapshotGroup",
      "rootVolumeId": 100,
      "type": "Snapshot",
      "poolId": 10,
      "usedCapacityPerRootVolume": 126,
      "isVolumeCapacityExpanding": false
    },
    {
      "id": "100,4",
      "masterVolumeId": 100,
      "snapshotId": 4,
      "status": "Completed",
      "snapshotDate": "2015-03-20T09:27:35Z",
      "snapshotGroupName": "snapshotGroup",
      "rootVolumeId": 100,
      "type": "Snapshot",
      "poolId": 10,
      "usedCapacityPerRootVolume": 126,
      "isVolumeCapacityExpanding": false
    },
  ],
  "count": 2,
  "totalCount": 2,
  "hasNext": false
}

Attribute

Type

Description

id

string

Master volume ID of the snapshot and the snapshot ID, linked by a comma

masterVolumeId

int

Master volume ID of the snapshot

snapshotId

int

Snapshot ID

The mirror unit number is obtained.

status

string

Status of the snapshot:

  • Creating: Snapshot creation is in progress
  • In Sync: Snapshot synchronization is complete
  • Splitting: Snapshot splitting is in progress
  • Completed: Snapshot creation is complete
  • Restoring: Snapshot restoration is in progress
  • Deleting:Snapshot deletion is in progress
  • Relocating: Snapshot data relocation is in progress
  • Preparing: Preparation for Snap Clone is in progress
  • Clone Ready: Snap Clone is ready
  • Cloning: Replication by using Snap Clone is in progress
  • Diff Cloning: Replication by using Diff Clone in the VASA environment is in progress
  • Removing: Removal of the Snap Clone settings is in progress
  • Error: A failure has occurred

snapshotDate

ISO8601string

Date and time when the snapshot was created

snapshotGroupName

string

Snapshot group name

mappedVolumeId

int

ID of the volume to be created from the snapshots

This attribute is obtained only if the ID of the volume for which the snapshot was created is defined.

rootVolumeId

int

ID of the root volume of the snapshots

poolId

int

ID of the pool in which the differential data of the snapshots is stored

usedCapacityPerRootVolume

long

The amount of disk space (MiB) occupied by differential information and control information used by the snapshot group created from the same volume.

isVolumeCapacityExpanding

boolean

Indicates whether the snapshot capacity is being expanded

  • true: Capacity expansion is in progress

    When a volume is mapped to the snapshot, true appears (indicating that processing to expand the capacity is occurring) if the capacity of the volume from which the snapshot was created differs from the capacity of the volume to which the snapshot is mapped.

    When no volume is mapped to the snapshot, true appears (indicating that processing to expand the capacity is occurring) only if processing is expanding the capacity of the volume from which the snapshot was created.

  • false: Capacity expansion is not occurring

type

string

Type of snapshot:

  • Snap Clone: Snap Clone replication is in progress
  • Snapshot: A snapshot or volume ID is defined for the snapshot
  • Diff Clone: Diff Clone replication in the VASA environment is in progress (VSP G130, G/F350, G/F370, G/F700, G/F900 models only)

diffCompareVolumeId

int

Volume ID of the base volume that is used when creating a Diff Clone

The attribute type appears only for Diff Clone.

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/snapshots