帮你快速理解、总结文档立即下载
文档中心>大数据智能体工作台 DataBuddy>API 文档>Catalog 相关接口>查询table详情

查询table详情

最近更新时间：2026-10-14 01:55:26
我的收藏

本页目录：

1. 接口描述

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

查询table详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：GetTable。
Version 是 String 公共参数，本接口取值：2026-07-15。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-jakarta, ap-shanghai, ap-singapore, ap-tokyo 。
CatalogName 是 String

数据目录名


示例值：capi_no_delete_table
SchemaName 是 String

数据库名


示例值：capi_no_delete_schema
TableName 是 String

表名


示例值：user_info_data
WorkspaceId 是 String

调用时所在workspace唯一id


示例值：17697667906247629
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 GetTableRsp

表信息


注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取table详情

获取table详情

输入示例

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

{
    "CatalogName": "capi_no_delete_table",
    "SchemaName": "capi_no_delete_schema",
    "TableName": "user_info_data",
    "WorkspaceId": "17697667906247629"
}

输出示例

{
    "Response": {
        "Data": {
            "Table": {
                "AssetGuid": "tccatalog.v1.uid3977620717726560546@251436191_ap-guangzhou_TABLE",
                "Audit": {
                    "CreatedAt": "1778828835347",
                    "Creator": "700002164618",
                    "CreatorName": "wedata30-dev@tencent.com",
                    "LastModifiedAt": "1778828835347",
                    "LastModifier": "700002164618",
                    "LastModifierName": "wedata30-dev@tencent.com"
                },
                "Columns": [
                    {
                        "Comment": "",
                        "FieldSetting": "",
                        "IsPrimaryKey": false,
                        "Name": "user_id",
                        "Tags": [],
                        "Type": "long"
                    }
                ],
                "Comment": "",
                "FeatureTableType": "",
                "FilesCount": "",
                "FilesSize": "",
                "Indexes": [],
                "MetaOwner": {
                    "FullName": "capi_no_delete_table.capi_no_delete_schema.user_info_data",
                    "Owner": "700002164618",
                    "OwnerName": "wedata30-dev@tencent.com",
                    "OwnerType": "user"
                },
                "Name": "user_info_data",
                "Partitioning": [],
                "Properties": [
                    {
                        "Key": "write.upsert.enabled",
                        "Value": "false"
                    }
                ],
                "TableFormat": "TCIceberg",
                "TableType": "Managed",
                "Tags": []
            }
        },
        "RequestId": "3e1b2e0c-d4a8-482c-96bf-773a4ce1877d"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.BizException 业务逻辑错误
InternalError.FailedOperation 操作失败
InvalidParameter.InvalidParameter 参数不正确
ResourceNotFound.CatalogNotFound 指定的 Catalog 不存在
ResourceNotFound.SchemaNotFound 指定的Schema不存在
ResourceNotFound.TableNotFound 指定的表不存在
中国站