1. 接口描述
接口请求域名: databuddy.tencentcloudapi.com 。
批量获取表的元数据。使用场景:根据表的全名列表(catalogName.schemaName.tableName)批量获取表的详细元数据信息。前置条件:需要有对应workspace的读权限,仅返回当前workspace有权限的catalog下的表。权限校验:通过getAuthedCatalogNames获取有权限的catalogName进行过滤,不在权限范围内的表会被静默跳过。限制:FullNames最大支持20个表全名
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:GetTables。 |
| Version | 是 | String | 公共参数,本接口取值:2026-07-15。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-jakarta, ap-shanghai, ap-singapore, ap-tokyo 。 |
| WorkspaceId | 是 | String | 调用时所在workspace唯一id,必填 示例值:17697667906247629 |
| FullNames.N | 是 | Array of String | 表的全名列表,格式为 catalogName.schemaName.tableName,必填,至少1条,最大20条 示例值:["c4.default.a"] |
| FetchOption | 否 | FetchOption | 数据获取选项,可选,控制是否返回权限信息及按权限过滤 |
| ConnectionId | 否 | String | 数据源连接ID,可选(融合版新增字段)。非空→走分析版路径,要求所有FullNames属于同一catalog(分析版额外约束);空/缺省→走专业版TcLake路径 示例值:capi_test_connection |
| CatalogSource | 否 | String | 数据目录来源,可选(Setats融合新增字段)。取值:METALAKE(专业版tclake)/ CONNECTION(分析版Linked Catalog)/ SETATS(Setats元数据)。路由优先级:显式非空CatalogSource > 非空ConnectionId(视为CONNECTION)> 默认METALAKE;CatalogSource非空时ConnectionId将被忽略。 示例值:METALAKE |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | GetTablesRsp | 返回结果 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 批量获取表元数据
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetTables
<公共请求参数>
{
"WorkspaceId": "17697667906247629",
"FullNames": [
"my_catalog.my_schema.my_table"
]
}
输出示例
{
"Response": {
"RequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"Data": {
"Items": [
{
"AssetGuid": "tccatalog.v1.xxx",
"Name": "my_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: 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.TableNotFound | 指定的表不存在 |