大数据智能体工作台 DataBuddy 获取数据目录列表

1. 接口描述

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

分页获取数据目录列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ListCatalogs。
Version	是	String	公共参数，本接口取值：2026-07-15。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-jakarta, ap-shanghai, ap-singapore, ap-tokyo 。
WorkspaceId	是	String	工作空间唯一id 示例值：17697667906247629
MaxResults	否	Integer	最大结果条数示例值：5
PageToken	否	String	分页token 示例值：eyJvZmZzZXQiOjF9
Types.N	否	Array of String	catalog类型，可填：TABLE、MODEL、VOLUME 示例值：["TABLE"]
CurrentWorkspaceOnly	否	Boolean	是否只返回当前工作空间有权限的，false时会额外返回当前用户有权限管理的catalog 示例值：true
FetchOption	否	FetchOption	数据获取选项，可选，控制是否返回权限信息及按权限过滤
CatalogSources.N	否	Array of String	数据目录来源筛选（融合版新增字段），取值参考 CatalogSourceEnum。空数组或不传→只查tclake；["METALAKE"]→只查tclake；["CONNECTION"]→只查分析版ana_catalog；["METALAKE","CONNECTION"]→合并返回示例值：["METALAKE"]

3. 输出参数

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

4. 示例

示例1 根据类型筛选示例

根据类型筛选示例

输入示例

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

{
    "WorkspaceId": "17697667906247629",
    "MaxResults": 5
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "AssetGuid": "tccatalog.v1.uid1682010588499561186@251436191_ap-guangzhou_CATALOG",
                    "Audit": {
                        "CreatedAt": "1779363594232",
                        "Creator": "zhipengxue2",
                        "CreatorName": "zhipengxue2",
                        "LastModifiedAt": "1779363606061",
                        "LastModifier": "700002657504",
                        "LastModifierName": "zhipengxue2"
                    },
                    "Comment": "",
                    "CurrentWorkspacePermissionLevel": 2,
                    "Id": "1aa25d21-335f-4dad-a7e6-fda752d7804a",
                    "Identifier": "tccatalog.v1.uid1682010588499561186",
                    "IsExternal": false,
                    "MetaOwner": {
                        "FullName": "afa",
                        "Owner": "700002657504",
                        "OwnerName": "zhipengxue2",
                        "OwnerType": "user"
                    },
                    "Name": "afa",
                    "Operator": "zhipengxue2",
                    "Properties": [
                        {
                            "Key": "gravitino.bypass.catalog-impl",
                            "Value": "org.apache.iceberg.hive.TCLakeHiveCatalog"
                        }
                    ],
                    "Status": "2",
                    "Tags": [],
                    "Type": "TABLE"
                }
            ],
            "NextPageToken": "eyJvZmZzZXQiOjV9"
        },
        "RequestId": "9362aef9-3934-4257-9b87-89e3078d281d"
    }
}

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. 错误码

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

错误码	描述
InternalError.BizException	业务逻辑错误
InternalError.FailedOperation	操作失败
InvalidParameter.InvalidParameter	参数不正确

获取数据目录列表

本页目录：