CreateBackup

Last updated: 2025-11-13 20:51:49

CreateBackup

Last updated: 2025-11-13 20:51:49

1. API Description

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

This API is used to create a manual backup for a cluster.

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: CreateBackup.
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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ClusterId	Yes	String	Cluster ID
BackupType	No	String	Backup type. Valid values: `logic` (logic backup), `snapshot` (physical backup)
BackupDatabases.N	No	Array of String	Backup database, which is valid when `BackupType` is `logic`.
BackupTables.N	No	Array of DatabaseTables	Backup table, which is valid when `BackupType` is `logic`.
BackupName	No	String	Backup name

3. Output Parameters

Parameter Name	Type	Description
FlowId	Integer	Async task flow 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.

4. Example

Example1 Creating a Backup

This example shows you how to create a backup.

Input Example

https://cynosdb.intl.tencentcloudapi.com/?Action=CreateBackup
&ClusterId=cynosdbpg-45knmnra
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "FlowId": 147189
    }
}

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
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.
InvalidParameterValue.InvalidParameterValueError	Invalid parameter value.
InvalidParameterValue.ParamError	Incorrect parameter.
OperationDenied.ServerlessInstanceStatusDenied	For the serverless instance in this status, the operation is not allowed.
ResourceNotFound.ClusterNotFoundError	The cluster does not exist.
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

Was this page helpful?

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

Yes

Feedback

tencent cloud