Retrieves the snaplock retention details of the specified file an indefinite expiry time indicates the file is under a legal-hold
Suggest changes
PDFs
learn more
-
[
doc /storage/snaplock/file/{volumeuuid}/{path}](#docs-snaplock-storage_snaplock_file_{volumeuuid}_{path})
GET /storage/snaplock/file/{volume.uuid}/{path}
Retrieves the SnapLock retention details of the specified file. An indefinite expiry time indicates the file is under a Legal-Hold.
Related ONTAP commands
-
volume file retention show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
volume.uuid |
string |
path |
True |
Volume UUID |
path |
string |
path |
True |
Path of the file in the form "/<dirpath>/<filename>" |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok| Name | Type | Description |
|---|---|---|
_links |
||
expiry_time |
string |
Expiry time of the file in date-time format. |
file_path |
string |
Specifies the volume relative path of the file |
svm |
||
volume |
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"expiry_time": "2058-06-04 19:00:00 UTC",
"file_path": "/dir1/file",
"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: DefaultONTAP Error Response codes
| Error code | Description |
|---|---|
14090347 |
File path must be in the format "/ |
| 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 |
|---|---|---|
self |
svm
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
volume
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the volume. |
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.
|
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. |