Last updated: 2019-11-29 19:08:17

1. API Description

Domain name for API request:

This API (ModifyBackupConfig) is used to modify the configuration of a database backup.

A maximum of 20 requests 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: ModifyBackupConfig
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.
ExpireDays No Integer Backup expiration time (in days). The minimum value is 7 days, and the maximum is 732 days.
StartTime No String Backup time range, such as 02:00-06:00. The start time and end time must be on the hour. Supported time ranges include: 02:00-06:00, 06:00-10:00, 10:00-14:00, 14:00-18:00, 18:00-22:00, and 22:00-02:00.
BackupMethod No String Target backup method. Supported values include: logical - logical cold backup (default), and physical - physical cold backup.

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. 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
CdbError Backend error or process error.
InternalError.DatabaseAccessError Database's internal error.
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound The instance does not exist.

5. Example

Example 1 Modify the configuration of a database backup

Input example
&<Common request parameters>

Output example

  "Response": {
    "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.