查询数据表列表

最近更新时间:2024-08-15 01:33:20

我的收藏

1. 接口描述

接口请求域名: dlc.tencentcloudapi.com 。

本接口(DescribeTables)用于查询数据表列表。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTables。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表
DatabaseName String 列出该数据库下所属数据表。
示例值:database1
Limit Integer 返回数量,默认为10,最大值为100。
示例值:20
Offset Integer 数据偏移量,从0开始,默认为0。
示例值:0
Filters.N Array of Filter 过滤条件,如下支持的过滤类型,传参Name应为其一
table-name - String - (过滤条件)数据表名称,形如:table-001。
table-id - String - (过滤条件)table id形如:12342。
DatasourceConnectionName String 指定查询的数据源名称,默认为DataLakeCatalog
示例值:DataLakeCatalog
StartTime String 起始时间:用于对更新时间的筛选,格式为yyyy-mm-dd HH:MM:SS
示例值:2006-01-02 15:04:05
EndTime String 终止时间:用于对更新时间的筛选,格式为yyyy-mm-dd HH:MM:SS
示例值:2006-01-02 15:04:05
Sort String 排序字段,支持:CreateTime(创建时间)、UpdateTime(更新时间)、StorageSize(存储空间)、RecordCount(行数)、Name(表名称)(不传则默认按name升序)
示例值:UpdateTime
Asc Boolean 排序字段,false:降序(默认);true:升序
示例值:false
TableType String table type,表类型查询,可用值:EXTERNAL_TABLE,INDEX_TABLE,MANAGED_TABLE,MATERIALIZED_VIEW,TABLE,VIEW,VIRTUAL_VIEW
示例值:Table
TableFormat String 筛选字段-表格式:不传(默认)为查全部;LAKEFS:托管表;ICEBERG:非托管iceberg表;HIVE:非托管hive表;OTHER:非托管其它;
示例值:HIVE

3. 输出参数

参数名称 类型 描述
TableList Array of TableResponseInfo 数据表对象列表。
TotalCount Integer 实例总数。
示例值:21
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例1

查询数据表列表。

输入示例

POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTables
<公共请求参数>

{
    "Limit": 1,
    "Offset": 0,
    "DatabaseName": "testdb",
    "DatasourceConnectionName": "DataLakeCatalog"
}

输出示例

{
    "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
                            },
                            "Index": {
                                "IndexEnable": "abc"
                            }
                        }
                    }
                },
                "Columns": [
                    {
                        "Name": "abc",
                        "Type": "abc",
                        "Comment": "abc",
                        "Precision": 0,
                        "Scale": 0,
                        "Nullable": "abc",
                        "Position": 0,
                        "CreateTime": "abc",
                        "ModifiedTime": "abc",
                        "IsPartition": true
                    }
                ],
                "Partitions": [
                    {
                        "Name": "abc",
                        "Type": "abc",
                        "Comment": "abc",
                        "Transform": "abc",
                        "TransformArgs": [
                            "abc"
                        ],
                        "CreateTime": 0
                    }
                ],
                "Location": "abc",
                "Properties": [
                    {
                        "Key": "abc",
                        "Value": "abc"
                    }
                ],
                "ModifiedTime": "abc",
                "CreateTime": "abc",
                "InputFormat": "abc",
                "StorageSize": 0,
                "RecordCount": 0,
                "MapMaterializedViewName": "abc"
            }
        ],
        "TotalCount": 1,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.InternalSystemException 业务系统异常,请重试或提工单联系我们。
InvalidParameter 参数错误。
InvalidParameter.DatasourceConnectionNotUnique 数据源连接已存在,请重试,或者提交工单联系我们
InvalidParameter.InvalidDatasourceConnectionConfig 数据源连接配置异常,请重试,或者提交工单联系我们
InvalidParameter.InvalidFilterKey 不支持此过滤条件
InvalidParameter.InvalidFilterLength 过滤条件个数非法,当指定了过滤条件时,过滤条件的个数应该大于等于1个,且小于等于5个
InvalidParameter.InvalidTimeParameter 日期参数异常,如结束时间早于开始时间
InvalidParameter.ParameterNotFoundOrBeNone 找不到参数或参数为空
ResourceNotFound.DatasourceNotFound 数据源连接不存在,请重试,或者提交工单联系我们
ResourceNotFound.TableNotFound 表不存在,请重试,或者提交工单联系我们
UnsupportedOperation.UnsupportedDatasourceConnectionType 不支持当前数据连接类型,当前仅支持: DataLakeCatalog/Mysql/HiveCos/HiveHdfs/HiveCHdfs/PostgreSql/SqlServer/ClickHouse