Update a file clone token
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
PATCH /storage/file/clone/tokens/{node.uuid}/{uuid}
Introduced In: 9.10
Updates a file clone token.
Related Ontap commands
-
volume file clone token modify
Modify clone token
Use the PATCH API to update the expiry time associated with the clone token.<br>
# The call: curl -X PATCH "https://<mgmt_ip>/api/storage/file/clone/tokens/97255711-a1ad-11eb-92b2-0050568eb2ca/905c42ce-a74b-11eb-bd86-0050568ec7ae" -d '{"expiry_time": {"limit": "5400"} }' # The response for successful PATCH is empty.
Learn More
-
[
DOC /storage/file/clone
]
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
node.uuid |
string |
path |
True |
Node UUID |
uuid |
string |
path |
True |
Token UUID |
Request Body
Name | Type | Description |
---|---|---|
_links |
||
expiry_time |
||
node |
||
reserve_size |
integer |
Specifies the available reserve in the file clone split load for the given token. Also note that the minimum value for reserve size is 4KB and any value specified below 4KB will be rounded off to 4KB. |
uuid |
string |
Token UUID. |
Response
Status: 200, Ok
Error
Status: Default
ONTAP Error Response Codes
Error Code | Description |
---|---|
13565958 |
Failed to get information about token |
13565960 |
Failed to modify token expiry limit for node |
Also see the table of common errors in the Response body overview section of this documentation.
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 |
self_link
Name | Type | Description |
---|---|---|
self |
expiry_time
Name | Type | Description |
---|---|---|
left |
string |
Specifies the time remaining before the given token expires in ISO-8601 format. |
limit |
string |
Specifies when the given token expires in ISO-8601 format. |
node
Name | Type | Description |
---|---|---|
name |
string |
Node name |
uuid |
string |
Node UUID |
token
token
Name | Type | Description |
---|---|---|
_links |
||
expiry_time |
||
node |
||
reserve_size |
integer |
Specifies the available reserve in the file clone split load for the given token. Also note that the minimum value for reserve size is 4KB and any value specified below 4KB will be rounded off to 4KB. |
uuid |
string |
Token UUID. |
error_arguments
Name | Type | Description |
---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_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. |