Help & DocumentationTencentDB for MySQLAPI DocumentsBackup APIsDescribeBackupConfig

DescribeBackupConfig

Last updated: 2020-03-23 14:59:40

PDF

Contents：

1. API Description

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

This API (DescribeBackupConfig) is used to query the configuration information of a TencentDB instance backup.

A maximum of 100 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cdb.ap-shanghai-fsi.tencentcloudapi.com

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: DescribeBackupConfig.
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 in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.

3. Output Parameters

Parameter Name Type Description
StartTimeMin Integer Earliest start time point of automatic backup, such as 2 (for 2:00 AM). (This field has been disused. You are recommended to use the BackupTimeWindow field)
StartTimeMax Integer Latest start time point of automatic backup, such as 6 (for 6:00 AM). (This field has been disused. You are recommended to use the BackupTimeWindow field)
BackupExpireDays Integer Backup file retention period in days.
BackupMethod String Backup mode. Value range: physical, logical
BinlogExpireDays Integer Binlog file retention period in days.
BackupTimeWindow CommonTimeWindow Time window for automatic instance backup.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying TencentDB instance backup configuration information

Input Example

https://cdb.tencentcloudapi.com/?Action=DescribeBackupConfig
&InstanceId=cdb-c1nl9rpv
&<common request parameters>

Output Example

{
  "Response": {
    "BackupMethod": "physical",
    "BinlogExpireDays": 7,
    "BackupExpireDays": 7,
    "StartTimeMin": 10,
    "StartTimeMax": 14,
    "BackupTimeWindow": {
      "Friday": "10:00-14:00",
      "Monday": "10:00-14:00",
      "Saturday": "10:00-14:00",
      "Sunday": "10:00-14:00",
      "Thursday": "10:00-14:00",
      "Tuesday": "10:00-14:00",
      "Wednesday": "10:00-14:00"
    },
    "RequestId": "9d73ec37-89b8-4d36-9f40-123123123"
  }
}

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.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

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.CdbCgwError Internal system error.
InternalError.DatabaseAccessError Internal database error.
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound The instance does not exist.