Retrieve EBR operations
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
GET /storage/snaplock/event-retention/operations
Introduced In: 9.7
Retrieves a list of all EBR operations.
Related ONTAP commands
-
snaplock event-retention show
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
volume.uuid |
string |
query |
False |
Volume UUID |
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records 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.
|
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
num_records |
integer |
Number of records |
records |
array[ebr_operation] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"id": 16842759,
"num_files_failed": 0,
"num_files_processed": 50,
"num_files_skipped": 2,
"num_inodes_ignored": 2,
"path": "/dir1/file",
"policy": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "string",
"retention_period": "P30M"
},
"state": "completed",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
}
]
}
Error
Status: Default
ONTAP Error Response codes
Error code | Description |
---|---|
14090242 |
Only a user with the security login role "vsadmin-snaplock" is allowed to perform this operation. |
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