tencent cloud

文档反馈

DeleteBackup

最后更新时间:2023-08-23 14:23:08

1. API Description

Domain name for API request: cynosdb.tencentcloudapi.com.

This API is used to delete the manual backup for a cluster. It cannot be used to delete the automatic backup.

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: DeleteBackup.
Version Yes String Common Params. The value used for this API: 2019-01-07.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ClusterId Yes String Cluster ID
SnapshotIdList.N No Array of Integer Backup file ID. This field is used by legacy versions and thus not recommended.
BackupIds.N No Array of Integer Backup file ID. This field is recommended.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Deleting a backup

Input Example

https://cynosdb.tencentcloudapi.com/?Action=DeleteBackup
&ClusterId=cynosdbpg-45knmnra
&SnapshotIdList.0=4928
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "128046"
    }
}

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
FailedOperation.DatabaseAccessError Failed to access the database. Please try again later. If the problem persists, please contact customer service.
FailedOperation.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.DbOperationFailed Failed to query the database.
InternalError.InternalHttpServerError An exception occurred while executing the HTTP request.
InternalError.SystemError Internal system error.
InvalidParameterValue.ParamError Incorrect parameter.
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication failed.