Help & DocumentationAPIsTencentDB for MySQLBackup APIsDescribeBackupDatabases

DescribeBackupDatabases

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

Contents：

1. API Description

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

This API is used to query the databases contained in a backup file. It has been disused.
After the legacy version becomes capable of full backup, if you want to download logical backup files by table, you need to use this API.
The new API (CreateBackup) can specify the table to be backed up when a logical backup file is created, which can be downloaded directly.

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: DescribeBackupDatabases.
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.
StartTime Yes String Start time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-07-12 10:29:20.
SearchDatabase No String Prefix of the database to be queried.
Offset No Integer Pagination offset.
Limit No Integer Number of entries per page. Value range: 1-2,000.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of the returned data entries.
Items Array of DatabaseName Array of eligible databases.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the List of Backup Databases

Input Example

https://cdb.tencentcloudapi.com/?Action=DescribeBackupDatabases
&InstanceId=cdb-c1nl9rpv
&StartTime=2017-07-12 10:29:20
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    "TotalCount": "2",
    "Items": [
      {
        "DatabaseName": "mysql"
      },
      {
        "DatabaseName": "test"
      }
    ]
  }
}

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