Retrieve shadow copy sets
Retrieves shadow copy sets to view the available shadow copies of your data, which can be useful for data recovery and versioning tasks.
HTTP method and endpoint
GET /protocols/cifs/shadowcopy-sets
Introduced in
ONTAP 9.11
Usage notes
Retrieves Shadowcopy Sets.
Related ONTAP commands
-
vserver cifs shadowcopy show-sets
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
keep_snapshots |
boolean |
query |
False |
Filter by keep_snapshots |
uuid |
string |
query |
False |
Filter by uuid |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
svm.name |
string |
query |
False |
Filter by svm.name |
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
desc] direction. Default direction is 'asc' for ascending. |
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 |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of records |
records |
array[shadowcopy_set] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"keep_snapshots": "",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"uuid": "f8328660-00e6-11e6-80d9-005056bd65a9"
}
]
}
Error
Status: Default, Error
| 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 |
svm
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
shadowcopy_set
| Name | Type | Description |
|---|---|---|
keep_snapshots |
boolean |
Request the storage system to keep the snapshot copies taken as a part of the shadow copy set creation. |
svm |
||
uuid |
string |
The universally-unique identifier of the storage's shadow copy set. |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |