Last updated: 2020-12-07 19:23:26

1. API Description

Domain name for API request:

This API is used to query the list of databases

A maximum of 20 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:

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: DescribeDBs.
Version Yes String Common parameter. The value used for this API: 2018-03-28.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceIdSet.N Yes Array of String Instance ID
Limit No Integer Number of results per page. Value range: 1-100. Default value: 20
Offset No Integer Page number. Default value: 0

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of databases
DBInstances Array of InstanceDBDetail List of instance 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 databases

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "RequestId": "5062de55-d048-4d3b-92f9-b98b6f244360",
    "TotalCount": 1,
    "DBInstances": [
        "InstanceId": "mssql-632eyp63",
        "DBDetails": [
            "Name": "ceshi1",
            "Charset": "Chinese_PRC_CI_AS",
            "Remark": "Test db1",
            "CreateTime": "2018-07-02 20:12:24",
            "Status": 2,
            "Accounts": [
                "UserName": "victorwind",
                "Privilege": "ReadWrite"
            "InternalStatus": "ONLINE"

5. Developer Resources


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.GcsError GCS API error.
InternalError.SystemError System error.
InvalidParameter.InputIllegal Input error.
InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
ResourceNotFound.InstanceNotFound The instance does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication error.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback