腾讯云数据仓库 TCHouse-D 获取表列表-库表相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： cdwdoris.tencentcloudapi.com 。

获取指定数据源和库下的表列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTableList。
Version	是	String	公共参数，本接口取值：2021-12-28。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	资源ID，建表所用的TCHouse-D资源ID。示例值：cdwdoris-bjizjxxx
DbName	是	String	需要获取表列表的库示例值：demo
UserName	否	String	使用该用户进行操作，该用户需要有对应的权限。如果该TCHouse-D集群使用CAM用户注册内核账户，则不需要填写示例值：user
PassWord	否	String	用户对应的密码。如果该TCHouse-D集群使用CAM用户注册内核账户，则不需要填写示例值：***
CatalogName	否	String	查询库所在的数据源，不填则默认为内部数据源（internal）。示例值：internal

3. 输出参数

参数名称	类型	描述
TableNames	Array of String	表名列表注意：此字段可能返回 null，表示取不到有效值。示例值：["test1","test2"]
Message	String	错误信息注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取表列表

获取internal数据源和demo库下的表列表

输入示例

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

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

输出示例

{
    "Response": {
        "Message": "",
        "RequestId": "28caf1f1-9192-477c-94d4-e910b87ca0fc",
        "TableNames": [
            "test",
            "table"
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

获取表列表

本页目录：