Last updated: 2019-12-14 10:52:19


1. API Description

Domain name for API request:

This API (CreateBackup) is used to create a database backup.

A maximum of 1 request can be initiated per second for this API.

Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example:

2. Input Parameters

The following request parameter list only provides API request parameters and some common 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: 2017-03-20
Region Yes String Common parameter. For more information, please see the [list of regions] supported by the product.
InstanceId Yes String Instance ID, such as: cdb-c1nl9rpv. It is identical to the instance ID displayed in the database console page.
BackupMethod Yes String Target backup method. Supported values include: logical - logical cold backup, and physical - physical cold backup.

3. Output Parameters

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

4. Error Codes

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's internal error.
InternalError.DesError System's internal error.
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound The instance does not exist.

5. Example

Example 1 Create a database backup

Input example
&<Common request parameters>

Output example

  "Response": {
    "BackupId": 102996666,
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"

6. Other Resources

Cloud API 3.0 comes with the following development tools to make it easier to call the API.