DescribeBackupDatabases

Recent Pages

Last updated: 2021-10-12 17:21:19

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.

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: 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 backed-up 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

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
CdbError	Backend or process error.
InternalError.DatabaseAccessError	Internal database error.
InvalidParameter	Parameter error.
InvalidParameter.InstanceNotFound	The instance does not exist.
OperationDenied.ActionNotSupport	Unsupported operation.
OperationDenied.UserHasNoStrategy	This account is not authorized to access the requested resource.

Recent Pages