1. 接口描述
接口请求域名: databuddy.tencentcloudapi.com 。
获取table列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ListTables。 |
| Version | 是 | String | 公共参数,本接口取值:2026-07-15。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-jakarta, ap-shanghai, ap-singapore, ap-tokyo 。 |
| CatalogName | 是 | String | 数据目录名 示例值:DataLakeCatalog |
| SchemaName | 是 | String | 数据库名 示例值:default |
| WorkspaceId | 是 | String | 调用时所在workspace唯一id 示例值:231434145236852 |
| MaxResults | 否 | Integer | 最大结果条数 示例值:1 |
| PageToken | 否 | String | 分页token 示例值:eyJvZmZzZXQiOjMwfQ== |
| FetchOption | 否 | FetchOption | 数据获取选项,可选,控制是否返回权限信息及按权限过滤 |
| ConnectionId | 否 | String | 数据源连接ID,可选(融合版新增字段)。非空→走分析版路径,空/缺省→走专业版TcLake路径 示例值:capi_test_connection |
| CatalogSource | 否 | String | 数据目录来源,可选(Setats融合新增字段)。取值:METALAKE(专业版tclake)/ CONNECTION(分析版Linked Catalog)/ SETATS(Setats元数据)。路由优先级:显式非空CatalogSource > 非空ConnectionId(视为CONNECTION)> 默认METALAKE;CatalogSource非空时ConnectionId将被忽略。 示例值:METALAKE |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | ListTablesRsp | 操作结果 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取table列表
获取table列表
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListTables
<公共请求参数>
{
"CatalogName": "DataLakeCatalog",
"SchemaName": "default",
"MaxResults": 1
}
输出示例
{
"Response": {
"Data": {
"Items": [
{
"Audit": {
"CreatedAt": "1761055196090",
"Creator": "1290245077@qq.com",
"LastModifiedAt": "1761055196633",
"LastModifier": "1290245077@qq.com"
},
"Columns": [
{
"Comment": "",
"FieldSetting": "",
"IsPrimaryKey": false,
"Name": "order_id_col",
"Type": "long"
},
{
"Comment": "",
"FieldSetting": "",
"IsPrimaryKey": false,
"Name": "customer_id_col",
"Type": "long"
},
{
"Comment": "",
"FieldSetting": "",
"IsPrimaryKey": false,
"Name": "order_date_col",
"Type": "timestamp_tz(6)"
},
{
"Comment": "",
"FieldSetting": "",
"IsPrimaryKey": false,
"Name": "product_id_col",
"Type": "integer"
},
{
"Comment": "",
"FieldSetting": "",
"IsPrimaryKey": false,
"Name": "product_name_col",
"Type": "string"
},
{
"Comment": "",
"FieldSetting": "",
"IsPrimaryKey": false,
"Name": "quantity_col",
"Type": "integer"
}
],
"Comment": "订单信息托管表(按订单日期分区)",
"Indexes": [],
"MetaOwner": {
"FullName": "DataLakeCatalog.default.order_managed_table",
"Owner": "1290245077@qq.com",
"OwnerType": "user"
},
"Name": "order_managed_table",
"Partitioning": [
{
"DayPartitioning": {
"FieldName": "order_date_col"
},
"Strategy": "day"
}
],
"Properties": [
{
"Key": "owner",
"Value": "root"
},
{
"Key": "write.parquet.compression-codec",
"Value": "zstd"
},
{
"Key": "current-snapshot-summary",
"Value": "{\"spark.app.id\":\"spark-b4e930acee7a446888167a444b7f292c\",\"added-data-files\":\"1\",\"added-records\":\"1\",\"added-files-size\":\"3246\",\"changed-partition-count\":\"1\",\"total-records\":\"1\",\"total-files-size\":\"3246\",\"total-data-files\":\"1\",\"total-delete-files\":\"0\",\"total-position-deletes\":\"0\",\"total-equality-deletes\":\"0\"}"
},
{
"Key": "write.metadata.delete-after-commit.enabled",
"Value": "true"
},
{
"Key": "tccatalog.identifier",
"Value": "tccatalog.v1.uid4204782243991625654"
},
{
"Key": "write.metadata.metrics.default",
"Value": "full"
},
{
"Key": "format",
"Value": "iceberg/parquet"
},
{
"Key": "format-version",
"Value": "2"
},
{
"Key": "uuid",
"Value": "2bdf0344-5b4d-4d58-a230-da913481d7fa"
},
{
"Key": "provider",
"Value": "iceberg"
},
{
"Key": "write.metadata.previous-versions-max",
"Value": "100"
},
{
"Key": "current-snapshot-id",
"Value": "7665350655544053728"
},
{
"Key": "lakehouse.storage.type",
"Value": "lakefs"
},
{
"Key": "current-snapshot-timestamp-ms",
"Value": "1761055200681"
},
{
"Key": "metadata_location",
"Value": "cosn://dlc4634-700001601851-1740545216-700001779129-251301051/1300298608/warehouse/default.db/order_managed_table.1761055194894/metadata/00001-8ed6ace3-fc7e-410d-9dbd-b0e9fc7b984f.metadata.json"
},
{
"Key": "location",
"Value": "cosn://dlc4634-700001601851-1740545216-700001779129-251301051/1300298608/warehouse/default.db/order_managed_table.1761055194894"
},
{
"Key": "write.distribution-mode",
"Value": "hash"
}
],
"TableFormat": "订单信息托管表(按订单日期分区)"
}
],
"NextPageToken": "eyJvZmZzZXQiOjF9"
},
"RequestId": "e74936a8-4226-4bdf-b24d-d1c8484cf410"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.BizException | 业务逻辑错误 |
| InternalError.FailedOperation | 操作失败 |
| InvalidParameter.InvalidParameter | 参数不正确 |
| ResourceNotFound.CatalogNotFound | 指定的 Catalog 不存在 |
| ResourceNotFound.SchemaNotFound | 指定的Schema不存在 |