tencent cloud



Last updated: 2023-09-19 17:36:49

1. API Description

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

This API is used to query table details.

A maximum of 20 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: 2019-08-23.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ClusterId No String ID of the cluster where the table to be queried resides
TableGroupIds.N No Array of String List of IDs of the table groups where the table to be queried resides
SelectedTables.N No Array of SelectedTableInfoNew Information list of tables to be queriedu200d. If you need to filter the tables, use theFilter parameter.
Filters.N No Array of Filter Filter. Valid values: TableName, TableInstanceId
Offset No Integer Query result offset
Limit No Integer Number of returned query results

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of tables
TableInfos Array of TableInfoNew Table details result list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the table list

This example shows you how to query the table list.

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "TotalCount": 1,
        "TableInfos": [
                "TableName": "abc",
                "TableInstanceId": "abc",
                "TableType": "abc",
                "TableIdlType": "abc",
                "ClusterId": "abc",
                "ClusterName": "abc",
                "TableGroupId": "abc",
                "TableGroupName": "abc",
                "KeyStruct": "abc",
                "ValueStruct": "abc",
                "ShardingKeySet": "abc",
                "IndexStruct": "abc",
                "ListElementNum": 1,
                "IdlFiles": [
                        "FileName": "abc",
                        "FileType": "abc",
                        "FileExtType": "abc",
                        "FileSize": 0,
                        "FileId": 0,
                        "FileContent": "abc"
                "ReservedVolume": 0,
                "ReservedReadQps": 0,
                "ReservedWriteQps": 0,
                "TableSize": 0,
                "Status": "abc",
                "CreatedTime": "abc",
                "UpdatedTime": "abc",
                "Memo": "abc",
                "Error": {
                    "Code": "abc",
                    "Message": "abc"
                "ApiAccessId": "abc",
                "SortFieldNum": 0,
                "SortRule": 0,
                "DbClusterInfoStruct": "abc",
                "TxhBackupExpireDay": 1,
                "SyncTableInfo": {
                    "TargetTableSplitNum": 1,
                    "TargetTableNamePrefix": [
                    "TargetSyncDBInstanceId": "abc",
                    "TargetDatabaseName": "abc",
                    "Status": 0,
                    "ClusterId": "abc",
                    "TableGroupId": 1,
                    "TableName": "abc",
                    "TableId": "abc",
                    "KeyFieldMapping": [
                            "SourceName": "abc",
                            "TargetName": "abc"
                    "ValueFieldMapping": [
                            "SourceName": "abc",
                            "TargetName": "abc"
        "RequestId": "abc"

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
AuthFailure.UnauthorizedOperation API operation authentication error.
FailedOperation Operation failed.
FailedOperation.RegionMismatch The requested region does not match.
InternalError Internal error.
InvalidParameterValue Incorrect parameter value.
ResourceNotFound The resource does not exist.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support