1. API Description
Domain name for API request: tcaplusdb.intl.tencentcloudapi.com.
This API is used to delete one or more table snapshots.
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.
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: DeleteSnapshots. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2019-08-23. |
| Region |
Yes |
String |
Common Params. For more information, please see the list of regions supported by the product. |
| ClusterId |
Yes |
String |
The ID of the cluster where the table resides |
| SelectedTables.N |
Yes |
Array of SnapshotInfoNew |
The list of snapshots to delete |
3. Output Parameters
| Parameter Name |
Type |
Description |
| TotalCount |
Integer |
The number of snapshots deleted in batches |
| TableResults |
Array of SnapshotResult |
The result list of snapshots deleted in batches |
| 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. |
4. Example
Example1 Deleting a snapshot
This example shows you how to delete a table snapshot.
POST / HTTP/1.1
Host: tcaplusdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteSnapshots
<Common request parameters>
{
"ClusterId": "xx",
"SelectedTables": [
{
"SnapshotName": "666",
"TableGroupId": "1",
"TableName": "cl_generic",
"SnapshotDeadTime": "2020-09-22 00:00:00"
}
]
}
Output Example
{
"Response": {
"RequestId": "17af6a7a-1fcc-4c1d-a4a2-caab4d9e75cc",
"TableResults": [
{
"Error": {
"Code": "",
"Message": ""
},
"SnapshotCreateTime": "2021-03-19 11:40:40",
"SnapshotDeadTime": "2021-03-20 11:40:30",
"SnapshotName": "666",
"SnapshotSize": 0,
"SnapshotStatus": 0,
"SnapshotTime": "2021-03-12 11:40:32",
"TableGroupId": "1",
"TableName": "cl_generic",
"TaskId": ""
}
],
"TotalCount": 1
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 |
| AuthFailure |
CAM signature/authentication error |
| AuthFailure.UnauthorizedOperation |
API operation authentication error. |
| FailedOperation |
Operation failed. |
| InternalError |
Internal error. |
| InvalidParameter |
Invalid parameter. |
| InvalidParameterValue |
Incorrect parameter value. |
| LimitExceeded |
The quota limit is exceeded. |
| MissingParameter |
Missing parameter. |
| ResourceNotFound |
The resource does not exist. |