Last updated: 2019-11-29 16:38:03

1. API Description

Domain name for API request:

This API (DescribeDatabases) is used to query the database information of a cloud database instance.

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:

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: DescribeDatabases
Version Yes String Common parameter. The value used for this API: 2017-03-20
Region Yes String Common parameter.
InstanceId Yes String Instance ID, such as cdb-c1nl9rpv. It is identical to the instance ID displayed in the database console page.
Offset No Integer Offset. The minimum value is 0.
Limit No Integer Number of results returned for a single request. Value range: [0-100].
DatabaseRegexp No String The regular expression that matches the database name. See MySQL website for rules.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of instances that meet the condition.
Items Array of String Returned instance information.
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.

Error Code Description
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound The instance does not exist.

5. Example

Example 1 Query database

Input example
&<Common request parameters>

Output example

  "Response": {
    "Items": [
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    "TotalCount": 7

6. Other Resources

Cloud API 3.0 comes with the following development tools to make it easier to call the API.