tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTable

Last updated: 2024-09-12 11:43:42

1. API Description

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

This API is used to obtain the table information. It only supports querying table information in the TCHouse-D internal catalog.

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: DescribeTable.
Version Yes String Common Params. The value used for this API: 2021-12-28.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Resource ID, which is the TCHouse-D resource ID used for table creation.
DbName Yes String Name of database where the table is located
TableName Yes String Table name (Currently only internal tables are supported.)
UserName No String Use the user who has corresponding permissions for operations. If the TCHouse-D cluster uses a kernel account registered by a CAM user, you do not need to fill it in.
PassWord No String Password corresponding to the user. If the TCHouse-D cluster uses a kernel account registered by a CAM user, you do not need to fill it in.

3. Output Parameters

Parameter Name Type Description
KeysType String Note: This field may return null, indicating that no valid values can be obtained.
Columns Array of Column Note: This field may return null, indicating that no valid values can be obtained.
IndexInfos Array of IndexInfo Note: This field may return null, indicating that no valid values can be obtained.
Partition Partition Note: This field may return null, indicating that no valid values can be obtained.
Distribution Distribution Note: This field may return null, indicating that no valid values can be obtained.
TableComment String Note: This field may return null, indicating that no valid values can be obtained.
Properties Array of Property Note: This field may return null, indicating that no valid values can be obtained.
Message String Note: This field may return null, indicating that no valid values can be obtained.
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 Obtaining the Table Information

This example shows you how to obtain the test table information under the demo database.

Input Example

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

{
    "InstanceId": "cdwdoris-bjizjxxx",
    "DbName": "demo",
    "TableName": "test"
}

Output Example

{
    "Response": {
        "Columns": [
            {
                "AggType": "",
                "AutoInc": false,
                "Comment": "User ID",
                "DefaultValue": "",
                "IsDistribution": true,
                "IsKey": true,
                "IsNull": false,
                "IsPartition": false,
                "Name": "user_id",
                "Type": "LARGEINT"
            },
            {
                "AggType": "",
                "AutoInc": false,
                "Comment": "Date and time of data writing",
                "DefaultValue": "",
                "IsDistribution": false,
                "IsKey": true,
                "IsNull": false,
                "IsPartition": true,
                "Name": "date",
                "Type": "DATE"
            },
            {
                "AggType": "",
                "AutoInc": false,
                "Comment": "User's city",
                "DefaultValue": "",
                "IsDistribution": false,
                "IsKey": true,
                "IsNull": true,
                "IsPartition": false,
                "Name": "city",
                "Type": "VARCHAR(20)"
            },
            {
                "AggType": "REPLACE",
                "AutoInc": false,
                "Comment": "User's last access time",
                "DefaultValue": "1970-01-01 00:00:00",
                "IsDistribution": false,
                "IsKey": false,
                "IsNull": false,
                "IsPartition": false,
                "Name": "last_visit_date",
                "Type": "DATETIME"
            },
            {
                "AggType": "SUM",
                "AutoInc": false,
                "Comment": "User's total consumption",
                "DefaultValue": "0",
                "IsDistribution": false,
                "IsKey": false,
                "IsNull": false,
                "IsPartition": false,
                "Name": "cost",
                "Type": "BIGINT"
            }
        ],
        "Distribution": {
            "Count": 3,
            "DistributionType": "Hash"
        },
        "IndexInfos": null,
        "KeysType": "AGG_KEY",
        "Message": "",
        "Partition": {
            "AutoPartition": false,
            "ListInfos": null,
            "PartitionType": "Range",
            "RangeInfos": [
                {
                    "Left": "",
                    "Max": "(\"2017-02-01\")",
                    "PartitionName": "0201",
                    "RangeType": "LESS THAN",
                    "Right": "",
                    "StepLength": 0,
                    "Unit": ""
                },
                {
                    "Left": "(\"2011-02-01\")",
                    "Max": "",
                    "PartitionName": "0202",
                    "RangeType": "FIXED",
                    "Right": "(\"2012-02-01\")",
                    "StepLength": 0,
                    "Unit": ""
                }
            ]
        },
        "Properties": [
            {
                "PropertyKey": "replication_allocation",
                "PropertyValue": "tag.location.default: 1"
            }
        ],
        "RequestId": "f4f99674-26f1-49c9-86eb-40f146f26b97",
        "TableComment": "example"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy