Documentation|Tencent Cloud

Recent Pages

Documentation

CreateBackup

Last updated: 2020-07-24 14:33:48

1. API Description

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

This API is used to create a backup task.

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 parameter. The value used for this API: CreateBackup.
Version	Yes	String	Common parameter. The value used for this API: 2019-08-23.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product. This API only supports: ap-hongkong, ap-seoul, ap-shanghai, ap-singapore, ap-taipei, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley
ClusterId	Yes	String	ID of the cluster where the table to be backed up resides
SelectedTables.N	Yes	Array of SelectedTableInfoNew	Information list of tables to be backed up
Remark	No	String	Remarks

3. Output Parameters

Parameter Name	Type	Description
TaskIds	Array of String	List of IDs of created backup tasks
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating backup

This example shows you how to create a backup.

Input Example

https://tcaplus.tencentcloudapi.com/?Action=CreateBackup
&ClusterId=22762983670
&SelectedTables.0.TableInstanceId=tcaplus-1f224454
&SelectedTables.0.TableGroupId=101
&SelectedTables.0.TableName=tb_example
&Remark=test
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "c3446e81-4d07-4a80-a07f-f34f94b598bc",
    "TaskIds": [
      "22762983670-1"
    ]
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

API 3.0 Explorer

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	Operation failed.
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameterValue	Incorrect parameter value.
ResourceNotFound	The resource does not exist.