大数据智能体工作台 DataBuddy 修改表信息

1. 接口描述

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

修改表信息
使用场景：修改表的名称或注释，按需传入NewName/NewComment字段
前置条件：表必须存在

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：UpdateTable。
Version	是	String	公共参数，本接口取值：2026-07-15。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-jakarta, ap-shanghai, ap-singapore, ap-tokyo 。
CatalogName	是	String	数据目录名称，必填示例值：my_catalog
SchemaName	是	String	数据库名称，必填示例值：my_schema
TableName	是	String	表名，必填示例值：my_table
WorkspaceId	是	String	调用时所在workspace唯一id，必填示例值：17697667906247629
NewName	否	String	新名称，可选，为空表示不修改名称示例值：new_table_name
NewComment	否	String	新描述，可选，为空表示不修改注释示例值：这是描述信息
ConnectionId	否	String	数据源连接ID，可选。分析版catalog不支持写操作，传入非空时返回错误。可通过 ListConnections 获取示例值：c7553f90-800d-47d0-be3f-f84ed3686718
CatalogSource	否	String	数据目录来源，可选（Setats融合新增字段）。取值：METALAKE（专业版tclake）/ CONNECTION（分析版Linked Catalog）/ SETATS（Setats元数据）。路由优先级：显式非空CatalogSource > 非空ConnectionId（视为CONNECTION）> 默认METALAKE；CatalogSource非空时ConnectionId将被忽略。示例值：METALAKE

3. 输出参数

参数名称	类型	描述
Data	UpdateTableRsp	返回结果
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改表信息

修改表的名称或注释

输入示例

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

{
    "CatalogName": "my_catalog",
    "SchemaName": "my_schema",
    "TableName": "my_table",
    "NewComment": "updated table comment",
    "WorkspaceId": "17697667906247629"
}

输出示例

{
    "Response": {
        "Data": {
            "Table": {
                "Name": "my_table",
                "Comment": "updated table comment"
            }
        },
        "RequestId": "c7553f90-800d-47d0-be3f-f84ed3686718"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

修改表信息

本页目录：