Release Notes
Announcements
Domain name for API request: cfs.intl.tencentcloudapi.com.
This API is used to update the name and retention period of a file system snapshot.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: UpdateCfsSnapshotAttribute. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-19. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| SnapshotId | Yes | String | Snapshot ID, which can be obtained by querying through the DescribeCfsSnapshots api. |
| SnapshotName | No | String | File system snapshot name, must fill in either this or AliveDays. snapshot name supports no more than 64 characters in length, supports chinese, numbers, _, and -. |
| AliveDays | No | Integer | File system snapshot retention days. either this or SnapshotName must be specified. if the original setting has permanent retention attribute, it is not allowed to be modified to short-term validity. |
| Parameter Name | Type | Description |
|---|---|---|
| SnapshotId | String | File system snapshot ID |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cfs.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateCfsSnapshotAttribute
<Common request parameters>
{
"SnapshotId": "snapcfs-agabg",
"SnapshotName": "defaultsnapshot",
"AliveDays": 1
}
{
"Response": {
"RequestId": "fjo8aejo-fjei-32eu-2je9-fhue83nd81",
"SnapshotId": "snapcfs-agabg"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InternalError.GetAccountStatusFailed | Failed to get the payment status of the user. |
| InvalidParameter | Invalid parameter. |
| InvalidParameter.InvalidSnapshotName | The file system snapshot parameter name is invalid. |
| InvalidParameter.SnapshotNameLimitExceeded | The file system snapshot name exceeds the upper limit. |
| InvalidParameterValue.InvalidSnapshotName | Invalid snapshot name. |
| InvalidParameterValue.InvalidSnapshotStatus | The snapshot is invalid. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.SnapshotNotFound | The snapshot ID does not exist. |
| UnsupportedOperation.OutOfService | Your account is in arrears. Please top up and try again. |
フィードバック