DescribeTables

Download PDF

Last updated: 2024-11-20 11:13:37

DescribeTables

Last updated: 2024-11-20 11:13:37

Download PDF

1. API Description

Domain name for API request: cdb.intl.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.

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 Params. The value used for this API: DescribeTables.
Version	Yes	String	Common Params. The value used for this API: 2017-03-20.
Region	Yes	String	Common Params. 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

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of eligible tables.
Items	Array of String	Information of a table.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying database tables

Input Example

POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTables
<Common request parameters>

{
    "InstanceId": "cdb-c1nl9rpv",
    "Database": "mysql"
}

Output Example

{
    "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"
        ]
    }
}

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

Tencent Cloud CLI 3.0

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.
InternalError.ExeSqlError	SQL statement error
InternalError.JSONError	Failed to parse JSON.
InternalError.NetworkError	Network error
InternalError.UnknownError	Unknown error
InvalidParameter	Parameter error.
InvalidParameter.InstanceNotFound	The instance does not exist.
InvalidParameterValue.InvalidParameterValueError	Invalid parameter value
OperationDenied	Operation denied.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud