The snapshot object contains information about a snapshot made for a volume. You can use the ListSnapshots API method to retrieve a list of snapshot information for a volume or for all volumes. The object includes information about the active snapshot as well as each snapshot created for a volume.

Object members

This object contains the following members:

Name Description Type
attributes List of name-value pairs in JSON object format. JSON object
checksum A small string representation of the data in the stored snapshot. This checksum can be used later to compare other snapshots to detect errors in the data. string
createTime The UTC+0 formatted time the snapshot was created. ISO 8601 date string
enableRemoteReplication Identifies if snapshot is enabled for remote replication. boolean
expirationReason Indicates how the snapshot expiration is set. Possible values:
  • Api: The expiration time is set by using the API.
  • None: No expiration time is set.
  • Test: The expiration time is set for testing.
expirationTime The time at which this snapshot will expire and be purged from the cluster. ISO 8601 date string
groupID The group ID if the snapshot is a member of a group snapshot. integer
groupsnapshotUUID Contains information about each snapshot in the group. Each of these members will have a UUID parameter for the snapshot’s UUID. string
instanceCreateTime The time that the snapshot was created on the local cluster. ISO 8601 date string
instanceSnapshotUUID The universally unique ID of the snapshot on the local cluster. This ID does not get replicated to other clusters. string
name The unique name assigned to the snapshot. If no name is specified, the name is the UTC+0 formatted timestamp of when the snapshot was created. string
remoteStatuses An array containing the universal identifier and replication status of each remote snapshot on the target cluster as seen from the source cluster. remoteClusterSnapshotStatus array
snapMirrorLabel The label used by SnapMirror software to specify snapshot retention policy on SnapMirror endpoints. If not set, this value is null. string
snapshotID The unique ID of an existing snapshot. string
snapshotUUID The universally unique ID of an existing snapshot. When the snapshot is replicated across clusters, this ID is replicated along with it and is used to identify the snapshot across clusters. string
status Current status of the snapshot. Possible values:
  • Unknown: There was an error obtaining the status of the snapshot.
  • Preparing: This snapshot is being prepared for use and is not yet writable.
  • RemoteSyncing: This snapshot is being replicated from a remote cluster.
  • Done: This snapshot has finished preparation or replication and is now usable.
  • Active: This snapshot is the active branch.
  • Cloning: This snapshot is involved in a CopyVolume operation.
totalSize The total size in bytes of the snapshot. integer
virtualVolumeID The ID of the virtual volume associated with this snapshot. UUID
volumeID The ID of the volume the snapshot was created from. integer
volumeName The name of the volume at the time the snapshot was created. string