DescribeDatabases

最后更新时间:2021-10-12 17:21:11

1. API Description

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

This API is used to query the information of databases in a TencentDB instance which must be a source or disaster recovery instance.

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: DescribeDatabases.
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.
Offset No Integer Offset. Minimum value: 0.
Limit No Integer Number of results to be returned for a single request. Value range: 1-100. Maximum value: 20.
DatabaseRegexp No String Regular expression for matching database names.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of eligible instances.
Items Array of String Information of an instance.
DatabaseList Array of DatabasesWithCharacterLists Database name and character set
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying databases

Input Example

https://cdb.tencentcloudapi.com/?Action=DescribeDatabases
&InstanceId=cdb-f35wr6wj
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    "DatabaseList": [
      {
        "CharacterSet": "UTF8",
        "DatabaseName": "test"
      }
    ],
    "TotalCount": 7,
    "Items": [
      "information_schema",
      "mysql",
      "performance_schema",
      "test",
      "trsf1",
      "trsf2",
      "trsf3"
    ]
  }
}

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

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
AuthFailure CAM signature/authentication error.
CdbError Backend or process error.
InternalError.ExeSqlError SQL statement error
InternalError.InternalServiceErrorErr An error occurred while accessing internal service.
InternalError.JSONError Failed to parse JSON.
InternalError.NetworkError Network error
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound The instance does not exist.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value
OperationDenied Operation denied.