tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDLCTableList

Last updated: 2024-08-21 19:10:31

1. API Description

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

This API is used to obtain the list of tables.

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: DescribeDLCTableList.
Version Yes String Common Params. The value used for this API: 2021-01-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
DbName No String Database name
Catalog No String Catalog name
Filters No Filter Query the list's filter criteria.
Type No String Table type
StartTime No String Start time
EndTime No String End time
Limit No Integer Pagination parameters
Offset No Integer Pagination parameters
Sort No String Sorting fields
Asc No Boolean Sorting rules: true for ascending order; false for descending order
TableFormat No String Data format type: hive, iceberg, etc.

3. Output Parameters

Parameter Name Type Description
TableList Array of DLCTable DLC metadata list information
Note: This field may return null, indicating that no valid values can be obtained.
TotalCount Integer Statistical value
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 List of Tables

Input Example

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

{
    "DbName": "abc",
    "Catalog": "abc",
    "Filters": {
        "Name": "abc",
        "Values": [
            "abc"
        ]
    },
    "Type": "abc",
    "StartTime": "abc",
    "EndTime": "abc",
    "Limit": 0,
    "Offset": 0,
    "Sort": "abc",
    "Asc": true,
    "TableFormat": "abc"
}

Output Example

{
    "Response": {
        "TableList": [
            {
                "TableBaseInfo": {
                    "DatabaseName": "abc",
                    "TableName": "abc",
                    "DatasourceConnectionName": "abc",
                    "TableComment": "abc",
                    "Type": "abc",
                    "TableFormat": "abc",
                    "UserAlias": "abc",
                    "UserSubUin": "abc",
                    "GovernPolicy": {
                        "RuleType": "abc",
                        "GovernEngine": "abc"
                    },
                    "DbGovernPolicyIsDisable": "abc",
                    "SmartPolicy": {
                        "BaseInfo": {
                            "Uin": "abc",
                            "PolicyType": "abc",
                            "Catalog": "abc",
                            "Database": "abc",
                            "Table": "abc",
                            "AppId": "abc"
                        },
                        "Policy": {
                            "Inherit": "abc",
                            "Resources": [
                                {
                                    "AttributionType": "abc",
                                    "ResourceType": "abc",
                                    "Name": "abc",
                                    "Instance": "abc",
                                    "Favor": [
                                        {
                                            "Priority": 0,
                                            "Catalog": "abc",
                                            "DataBase": "abc",
                                            "Table": "abc"
                                        }
                                    ],
                                    "Status": 0
                                }
                            ],
                            "Written": {
                                "WrittenEnable": "abc"
                            },
                            "Lifecycle": {
                                "LifecycleEnable": "abc",
                                "Expiration": 0,
                                "DropTable": true,
                                "ExpiredField": "abc",
                                "ExpiredFieldFormat": "abc"
                            },
                            "Index": {
                                "IndexEnable": "abc"
                            }
                        }
                    }
                },
                "Columns": [
                    {
                        "Name": "abc",
                        "Type": "abc",
                        "Comment": "abc",
                        "Default": "abc",
                        "NotNull": true,
                        "Precision": 0,
                        "Scale": 0,
                        "Position": 0,
                        "IsPartition": true
                    }
                ],
                "Partitions": [
                    {
                        "Name": "abc",
                        "Type": "abc",
                        "Comment": "abc",
                        "PartitionType": "abc",
                        "PartitionFormat": "abc",
                        "PartitionDot": 0,
                        "Transform": "abc",
                        "TransformArgs": [
                            "abc"
                        ]
                    }
                ],
                "Location": "abc",
                "Properties": [
                    {
                        "Key": "abc",
                        "Value": "abc"
                    }
                ],
                "ModifiedTime": "abc",
                "CreateTime": "abc",
                "InputFormat": "abc",
                "StorageSize": 0,
                "RecordCount": 0,
                "MapMaterializedViewName": "abc",
                "HeatValue": 0,
                "ExternalDataConfiguration": {
                    "Sds": {
                        "Location": "abc",
                        "InputFormat": "abc",
                        "OutputFormat": "abc",
                        "NumBuckets": 0,
                        "Compressed": true,
                        "StoredAsSubDirectories": true,
                        "SerdeLib": "abc",
                        "SerdeName": "abc",
                        "Params": [],
                        "SerdeParams": [],
                        "SortColumns": [],
                        "BucketCols": [
                            "abc"
                        ],
                        "SortCols": {
                            "Col": "abc",
                            "Order": 0
                        },
                        "Cols": [
                            {
                                "Name": "abc",
                                "Description": "abc",
                                "Type": "abc",
                                "Position": 0,
                                "IsPartition": true
                            }
                        ]
                    },
                    "ViewOriginalText": "abc",
                    "ViewExpandedText": "abc",
                    "Retention": 0,
                    "LifeTime": 0,
                    "Partitions": [
                        {
                            "DatabaseName": "abc",
                            "SchemaName": "abc",
                            "TableName": "abc",
                            "DataVersion": 0,
                            "Name": "abc",
                            "Params": [],
                            "Values": [
                                "abc"
                            ],
                            "StorageSize": 0,
                            "RecordCount": 0,
                            "CreateTime": "2020-09-22T00:00:00+00:00",
                            "ModifiedTime": "2020-09-22T00:00:00+00:00",
                            "LastAccessTime": "2020-09-22T00:00:00+00:00",
                            "Sds": {
                                "Location": "abc",
                                "InputFormat": "abc",
                                "OutputFormat": "abc",
                                "NumBuckets": 0,
                                "Compressed": true,
                                "StoredAsSubDirectories": true,
                                "SerdeLib": "abc",
                                "SerdeName": "abc",
                                "Params": [],
                                "SerdeParams": [],
                                "SortColumns": [],
                                "BucketCols": [
                                    "abc"
                                ],
                                "SortCols": {
                                    "Col": "abc",
                                    "Order": 0
                                },
                                "Cols": [
                                    {
                                        "Name": "abc",
                                        "Description": "abc",
                                        "Type": "abc",
                                        "Position": 0,
                                        "IsPartition": true
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        ],
        "TotalCount": 0,
        "RequestId": "abc"
    }
}

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

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError An internal error occurred.
InternalError.InternalSystemException The business system is abnormal. Please try again or submit a ticket to contact us.
InvalidParameter The parameter is incorrect.
ResourceNotFound The resource does not exist.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy