Domain name for API request: cdb.tencentcloudapi.com.
This API is used to query the information of database tables in a TencentDB instance. It only supports source or disaster recovery instances.
A maximum of 40 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: cdb.ap-shanghai-fsi.tencentcloudapi.com
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: DescribeTables. |
| 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. |
| Database | Yes | String | Database name. |
| Offset | No | Integer | Record offset. Default value: 0. |
| Limit | No | Integer | Number of results to be returned for a single request. Default value: 20. Maximum value: 2,000. |
| TableRegexp | No | String | Regular expression for matching table names, which complies with the rules at MySQL's official website |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible tables. |
| Items | Array of String | Information of a table. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://cdb.tencentcloudapi.com/?Action=DescribeTables
&InstanceId=cdb-c1nl9rpv
&Database=mysql
&<Common request parameters>{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"TotalCount": 10,
"Items": [
"CHARACTER_SETS",
"COLLATIONS",
"COLLATION_CHARACTER_SET_APPLICABILITY",
"COLUMNS",
"COLUMN_PRIVILEGES",
"ENGINES",
"EVENTS",
"FILES",
"GLOBAL_STATUS",
"GLOBAL_VARIABLES"
]
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| InvalidParameter | Parameter error. |
| InvalidParameter.InstanceNotFound | The instance does not exist. |
| OperationDenied | Operation denied. |
Was this page helpful?