DescribeBackupDatabases
Last updated: 2018-10-12 16:08:37
Contents：
1. API Description
Domain name for API request: cdb.tencentcloudapi.com.
This API (DescribeBackupDatabases) is used to query the list of backup databases.
A maximum of 100 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: 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, such as: cdb-c1nl9rpv. It is identical to the instance ID displayed in the database console page. |
| StartTime | Yes | String | Start time, such as 2017-07-12 10:29:20. |
| SearchDatabase | No | String | The prefix of the database to be queried. |
| Offset | No | Integer | Page offset. |
| Limit | No | Integer | Page size. The maximum is 2000. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of returned results |
| Items | Array of DatabaseName | An array of databases that meet the condition |
| 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. |
| InvalidParameter | Parameter error. |
| InvalidParameter.InstanceNotFound | The instance does not exist. |
5. Example
Example 1 Query 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": {
"Items": [
{
"DatabaseName": "mysql"
},
{
"DatabaseName": "test"
}
],
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"TotalCount": "2"
}
}6. Other Resources
Cloud API 3.0 comes with the following development tools to make it easier to call the API.
