1. API Description
Domain name for API request: cfs.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.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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 | No | String | Common Params. This parameter is not required for this API. |
| SnapshotId | Yes | String | File system snapshot ID |
| SnapshotName | No | String | File system snapshot name |
| AliveDays | No | Integer | File system snapshot retention period in days |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| SnapshotId | String | File system snapshot ID |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Updating the content of a snapshot
Input Example
POST / HTTP/1.1
Host: cfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateCfsSnapshotAttribute
<Common request parameters>
{
"SnapshotId": "snapcfs-12345",
"SnapshotName": "xx"
}
Output Example
{
"Response": {
"RequestId": "fjo8aejo-fjei-32eu-2je9-fhue83nd81",
"SnapshotId": "snapcfs-12345"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
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.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. |
是
否
本页内容是否解决了您的问题？