CreateDBSBackup

Last updated:2026-03-13 18:56:46

CreateDBSBackup

Last updated: 2026-03-13 18:56:46

1. API Description

Domain name for API request: tdmysql.intl.tencentcloudapi.com.

Create an instance backup set.

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: CreateDBSBackup.
Version	Yes	String	Common Params. The value used for this API: 2021-11-22.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
BackupMethod	Yes	String	Backup method: physical, snapshot. this value should be consistent with the backupMethod in the api response of DescribeDBSBackupPolicy. enumeration value: physical: physical backup snapshot: snapshot backup
BackupType	Yes	String	Backup type: currently, only supports full.
InstanceId	Yes	String	Instance ID.
BackupName	No	String	Backup notes.

3. Output Parameters

Parameter Name	Type	Description
BackupSetId	Integer	Backup set ID. .
IsSuccess	Boolean	Whether it is successful .
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 Creating a Backup Set

Create a backup set manually

Input Example

POST / HTTP/1.1
Host: dbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBackup
<Common request parameters>

{
    "InstanceId": "tdsql3-xxx",
    "BackupMethod": "physical",
    "BackupType": "full",
    "BackupName": "test-backup"
}

Output Example

{
    "Response": {
        "IsSuccess": true,
        "BackupSetId": 0,
        "RequestId": "fsafdsfasdfasdfsd"
    }
}

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

Tencent Cloud CLI 3.0

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
InternalError.DatabaseAccessError	Database access error.
InternalError.RouterNotFound	Route not found. whether parameter passing is incorrect.
OperationDenied.CreateBackupTaskThresholdErr	The count of backup tasks created exceeds the threshold.
OperationDenied.ManualBackupQuotaPerDayExceededErr	The quota for performing manual backup on a single instance per day.
OperationDenied.ManualBackupSetQuotaExceededErr	The number of backups exceeds the quota. backups cannot be created again.
ResourceNotFound.BizResourceNotFoundError	Instance resource not found.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud