Retrieve volume Snapshot copies
GET /storage/volumes/{volume.uuid}/snapshots
Introduced In: 9.6
Retrieves a collection of volume Snapshot copies.
Expensive properties
There is an added computational cost to retrieving the amount of reclaimable space for Snapshot copies, as the calculation is done on demand based on the list of Snapshot copies provided.
-
reclaimable_space
-
delta
Related ONTAP commands
-
snapshot show
-
snapshot compute-reclaimable
-
snapshot show-delta
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
volume.uuid |
string |
path |
True |
Volume |
uuid |
string |
query |
False |
Filter by uuid |
comment |
string |
query |
False |
Filter by comment |
expiry_time |
string |
query |
False |
Filter by expiry_time |
snaplock_expiry_time |
string |
query |
False |
Filter by snaplock_expiry_time |
owners |
string |
query |
False |
Filter by owners
|
snaplock.expiry_time |
string |
query |
False |
Filter by snaplock.expiry_time
|
snaplock.time_until_expiry |
string |
query |
False |
Filter by snaplock.time_until_expiry
|
snaplock.expired |
boolean |
query |
False |
Filter by snaplock.expired
|
create_time |
string |
query |
False |
Filter by create_time |
reclaimable_space |
integer |
query |
False |
Filter by reclaimable_space
|
version_uuid |
string |
query |
False |
Filter by version_uuid
|
logical_size |
integer |
query |
False |
Filter by logical_size
|
size |
integer |
query |
False |
Filter by size
|
volume.name |
string |
query |
False |
Filter by volume.name |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
svm.name |
string |
query |
False |
Filter by svm.name |
name |
string |
query |
False |
Filter by name |
delta.time_elapsed |
string |
query |
False |
Filter by delta.time_elapsed
|
delta.size_consumed |
integer |
query |
False |
Filter by delta.size_consumed
|
snapmirror_label |
string |
query |
False |
Filter by snapmirror_label
|
provenance_volume.uuid |
string |
query |
False |
Filter by provenance_volume.uuid
|
state |
string |
query |
False |
Filter by state |
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
delta |
Reports the amount of space consumed between two WAFL file systems, in bytes. The two WAFL file systems should be specified in a comma-separated format using the "name" parameter. To determine the space consumed between a Snapshot copy and the Active File System, only the Snapshot copy name needs to be mentioned. |
|
num_records |
integer |
Number of records |
reclaimable_space |
integer |
Space reclaimed when the Snapshot copy is deleted, in bytes. |
records |
array[snapshot] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"delta": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"size_consumed": 0,
"time_elapsed": "string"
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"comment": "string",
"create_time": "2019-02-04 14:00:00 -0500",
"delta": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"size_consumed": 0,
"time_elapsed": "string"
},
"expiry_time": "2019-02-04 14:00:00 -0500",
"logical_size": 1228800,
"name": "this_snapshot",
"owners": [
"string"
],
"provenance_volume": {
"uuid": "4cd8a442-86d1-11e0-ae1c-125648563413"
},
"size": "122880",
"snaplock": {
"expired": 1,
"expiry_time": "2019-02-04 14:00:00 -0500",
"time_until_expiry": "PT3H27M45S"
},
"snaplock_expiry_time": "2019-02-04 14:00:00 -0500",
"snapmirror_label": "string",
"state": "string",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
"version_uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
}
]
}
Error
Status: Default
ONTAP Error Response Code
Error Code | Description |
---|---|
918235 |
The specified volume is invalid. |
9437613 |
The operation is not supported on FlexCache Volumes. |
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
next |
||
self |
_links
Name | Type | Description |
---|---|---|
self |
snapshot_delta
Reports the amount of space consumed between two WAFL file systems, in bytes. The two WAFL file systems should be specified in a comma-separated format using the "name" parameter. To determine the space consumed between a Snapshot copy and the Active File System, only the Snapshot copy name needs to be mentioned.
Name | Type | Description |
---|---|---|
_links |
||
size_consumed |
integer |
Indicates the space that has changed between two specified WAFL file systems, in bytes. |
time_elapsed |
string |
Time elapsed between two specified WAFL file systems. |
provenance_volume
Name | Type | Description |
---|---|---|
uuid |
string |
UUID for the volume that is used to identify the source volume in a mirroring relationship. When the mirroring relationship is broken, a volume's Instance UUID and Provenance UUID are made identical. An unmirrored volume's Provenance UUID is the same as its Instance UUID. This field is valid for flexible volumes only. |
snaplock
Name | Type | Description |
---|---|---|
expired |
boolean |
Indicates whether a SnapLock Snapshot copy has expired. |
expiry_time |
string |
SnapLock expiry time for the Snapshot copy, if the Snapshot copy is taken on a SnapLock volume. A Snapshot copy is not allowed to be deleted or renamed until the SnapLock ComplianceClock time goes beyond this retention time. This option can be set during Snapshot copy POST and Snapshot copy PATCH on Snapshot copy locking enabled volumes. |
time_until_expiry |
string |
Indicates the remaining SnapLock expiry time of a locked Snapshot copy, in seconds. This field is set only when the remaining time interval is less than 136 years. |
svm
SVM, applies only to SVM-scoped objects.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the SVM. This field cannot be specified in a PATCH method. |
uuid |
string |
The unique identifier of the SVM. This field cannot be specified in a PATCH method. |
volume
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the volume. This field cannot be specified in a POST or PATCH method. |
uuid |
string |
Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.
|
snapshot
The Snapshot copy object represents a point in time Snapshot copy of a volume.
Name | Type | Description |
---|---|---|
_links |
||
comment |
string |
A comment associated with the Snapshot copy. This is an optional attribute for POST or PATCH. |
create_time |
string |
Creation time of the Snapshot copy. It is the volume access time when the Snapshot copy was created. |
delta |
Reports the amount of space consumed between two WAFL file systems, in bytes. The two WAFL file systems should be specified in a comma-separated format using the "name" parameter. To determine the space consumed between a Snapshot copy and the Active File System, only the Snapshot copy name needs to be mentioned. |
|
expiry_time |
string |
The expiry time for the Snapshot copy. This is an optional attribute for POST or PATCH. Snapshot copies with an expiry time set are not allowed to be deleted until the retention time is reached. |
logical_size |
integer |
Size of the logical used file system at the time the Snapshot copy is captured. |
name |
string |
Snapshot copy. Valid in POST or PATCH. |
owners |
array[string] |
|
provenance_volume |
||
reclaimable_space |