tencent cloud

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.

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.

3. Output Parameters

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.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

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