Read
GET v1/snapshots
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsVolSnapName |
| description | NsDescription |
| size | NsUnsignedLong |
| vol_name | NsVolSnapName |
| vol_id | NsObjectID |
| snap_collection_name | NsVolSnapName |
| snap_collection_id | NsObjectID |
| online | NsBoolean |
| writable | NsBoolean |
| offline_reason | NsOfflineReason |
| origin_name | NsObjectName |
| is_replica | NsBoolean |
| is_unmanaged | NsBoolean |
| replication_status | NsSnapReplStatus |
| serial_number | NsISCSISerialNumber |
| target_name | NsTargetName |
| creation_time | NsTime |
| last_modified | NsTime |
| schedule_name | NsObjectName |
| schedule_id | NsObjectID |
| app_uuid | NsAppUuid |
| new_data_valid | NsBoolean |
| new_data_compressed_bytes | NsBytes |
| new_data_uncompressed_bytes | NsBytes |
| agent_type | NsAgentType |
| vpd_t10 | NsString |
| vpd_ieee0 | NsString |
| vpd_ieee1 | NsString |
GET v1/snapshots/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| fields | NsCommaSeparatedList |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsVolSnapName |
| description | NsDescription |
| size | NsUnsignedLong |
| vol_name | NsVolSnapName |
| vol_id | NsObjectID |
| snap_collection_name | NsVolSnapName |
| snap_collection_id | NsObjectID |
| online | NsBoolean |
| writable | NsBoolean |
| offline_reason | NsOfflineReason |
| origin_name | NsObjectName |
| is_replica | NsBoolean |
| is_unmanaged | NsBoolean |
| replication_status | NsSnapReplStatus |
| serial_number | NsISCSISerialNumber |
| target_name | NsTargetName |
| creation_time | NsTime |
| last_modified | NsTime |
| schedule_name | NsObjectName |
| schedule_id | NsObjectID |
| app_uuid | NsAppUuid |
| new_data_valid | NsBoolean |
| new_data_compressed_bytes | NsBytes |
| new_data_uncompressed_bytes | NsBytes |
| agent_type | NsAgentType |
| vpd_t10 | NsString |
| vpd_ieee0 | NsString |
| vpd_ieee1 | NsString |
Description
Retrieve attributes from a single snapshot or a list of snapshots for a given volume. When asking for a list of snapshots, at least one filter criteria must be specified(e.g. vol_id, vol_name, serial_number). Multiple filters are supported.
Normal Response Codes
200 206
HTTP Error Codes
400 401 403 404 500 503
Detail Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for the snapshot. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsVolSnapName | string | Name of snapshot. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints. | |
| description | NsDescription | string | Text description of snapshot. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | |
| size | NsUnsignedLong | number | Size of volume at time of snapshot (in bytes). Unsigned 64-bit integer. Example: 1234. | |
| vol_name | NsVolSnapName | string | Name of the parent volume in which the snapshot belongs to. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints. | |
| vol_id | NsObjectID | string | Parent volume ID. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| snap_collection_name | NsVolSnapName | string | Name of snapshot collection. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints. | |
| snap_collection_id | NsObjectID | string | Identifier of snapshot collection. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| online | NsBoolean | boolean | Online state for a snapshot means it could be mounted for data restore. Possible values: 'true', 'false'. | |
| writable | NsBoolean | boolean | Allow snapshot to be writable. Mandatory and must be set to 'true' for VSS application synchronized snapshots. Possible values: 'true', 'false'. | |
| offline_reason | NsOfflineReason | string enum | Snapshot offline reason - possible entries: one of 'user', 'recovery', 'replica', 'over_volume_limit', 'over_snapshot_limit', 'over_volume_reserve', 'nvram_loss_recovery'. Possible values: 'user', 'recovery', 'replica', 'over_volume_limit', 'over_snapshot_limit', 'over_volume_reserve', 'over_snapshot_reserve', 'nvram_loss_recovery', 'serial_number_collision', 'encryption_inactive', 'encryption_key_deleted', 'vvol_unbind', 'cache_unpin_in_progress'. | |
| origin_name | NsObjectName | string | Origination group name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| is_replica | NsBoolean | boolean | Snapshot is a replica from upstream replication partner. Possible values: 'true', 'false'. | |
| is_unmanaged | NsBoolean | boolean | Is snapshot unmanaged, so that it will not be deleted automatically. Possible values: 'true', 'false'. | |
| replication_status | NsSnapReplStatus | string enum | Replication status. Possible values: 'complete', 'in_progress', 'pending'. | |
| access_control_records | NsAccessControlRecords | Array of NsAccessControlRecord | List of access control records that apply to this snapshot. List of access control records associated with a volume or snapshot or protocol endpoint. | |
| serial_number | NsISCSISerialNumber | string | Identifier for the SCSI protocol. A 32 digit hexadecimal number. Example: '1234123412341234abcdacbdacbdacbd'. | |
| target_name | NsTargetName | string | The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target snapshot. The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target. | |
| creation_time | NsTime | number | Time when this snapshot was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_modified | NsTime | number | Time when this snapshort was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| schedule_name | NsObjectName | string | Name of protection schedule. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| schedule_id | NsObjectID | string | Identifier of protection schedule. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| app_uuid | NsAppUuid | string | Application identifier of snapshots. String of up to 255 alphanumeric characters, hyphen, colon, dot and underscore are allowed. Example: 'rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18'. | |
| metadata | NsKeyValues | Array of NsKeyValue | Key-value pairs that augment a snapshot's attributes. List of key-value pairs. Keys must be unique and non-empty. When creating an object, values must be non-empty. When updating an object, an empty value causes the corresponding key to be removed. | |
| new_data_valid | NsBoolean | boolean | Indicate the usage infomation is valid. Possible values: 'true', 'false'. | |
| new_data_compressed_bytes | NsBytes | number | The bytes of compressed new data. Unsigned 64-bit integer. Example: '1234'. | |
| new_data_uncompressed_bytes | NsBytes | number | The bytes of uncompressed new data. Unsigned 64-bit integer. Example: '1234'. | |
| agent_type | NsAgentType | string enum | External management agent type. Possible values: 'none', 'smis', 'vvol', 'openstack', 'openstackv2'. | |
| vpd_t10 | NsString | string | The snapshot's T10 Vendor ID-based identifier. Plain string. | |
| vpd_ieee0 | NsString | string | The first 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string. Plain string. | |
| vpd_ieee1 | NsString | string | The last 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string. Plain string. |
JSON Response
{
"data" : {
"serial_number" : "868f60d7ba02ab0c6c9ce900d3040000",
"schedule_name" : "",
"schedule_id": "",
"access_control_records" : null,
"size" : 104857600,
"new_data_valid" : true,
"new_data_uncompressed_bytes" : 0,
"new_data_compressed_bytes" : 0,
"target_name" : "iqn.2007-11.com.storage:vol0.819247837950574-mysnapname-v00000000000004d3.00000007.000004d3.s00000000000004d3.00000007.00000003",
"metadata":[
{"key":"key1","value":"val1"},
{"key":"key2","value":"val2"}
],
"creation_time" : 1430776452,
"id" : "0400000000000004d3000000000000000700000003",
"is_replica" : false,
"snap_collection_name" : "87392237125035100421193182774960967539214650277633518424515",
"writable" : false,
"is_unmanaged" : true,
"last_modified" : 1430776452,
"name" : "mysnapname",
"description" : "mydescription",
"origin_name" : "g1a1",
"vol_id" : "0600000000000004d3000000000000000000000007",
"online" : false,
"snap_collection_id" : "0500000000000004d3000000000000000000000003",
"app_uuid" : "",
"vol_name" : "vol0.819247837950574",
"replication_status" : null,
"offline_reason" : "user"
}
}