数据湖计算 DLC 查询数据目录列表

1. 接口描述

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

查询数据目录列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCatalogs。
Version	是	String	公共参数，本接口取值：2021-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。
CatalogId	否	String	数据目录 ID 示例值：be32d91c-9ea3-4397-982e-fc9578142942
Name	否	String	数据目录名称示例值：chenfan_test_1
Operator	否	String	操作人 uin 示例值：700002744585
Sort	否	String	排序字段，支持 CreateTime / UpdateTime（默认 UpdateTime）示例值：CreateTime
Asc	否	String	true:升序（默认）/ false:降序示例值：true
Limit	否	Integer	分页大小示例值：100
Offset	否	Integer	分页偏移示例值：0
Status	否	Integer	状态：0 注册中 / 1 待测试 / 2 连接成功 / 3 连接失败 / 4 删除中 / 5 已删除枚举值： 0：注册中示例值：0
Type	否	String	数据目录类型枚举值： LAKEHOUSE： lakehouse类型示例值：LAKEHOUSE
CreatedAfter	否	Integer	在这个时间之后创建（时间戳）示例值：1788268042334
CreatedBefore	否	Integer	在这个时间之前创建（时间戳）示例值：1788268042334

3. 输出参数

参数名称	类型	描述
Catalogs	Array of CatalogConfig	Catalog详细信息列表
Total	Integer	Catalog总数示例值：5
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例1

输入示例

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

{}

输出示例

{
    "Response": {
        "Catalogs": [
            {
                "Audit": {
                    "CreatedAt": 1788268042334,
                    "CreatedTime": "",
                    "Creator": "700002744585",
                    "LastModifiedAt": 1788511393388,
                    "LastModifiedTime": "",
                    "LastModifier": "700002744585"
                },
                "Comment": "test_1",
                "Connection": {
                    "LakeHouseConnection": {
                        "Location": "cosn://tcs-a54320701c-1785327710-251438733/260209337/warehouse/chenfan_test_1/"
                    }
                },
                "CreateTime": "2026-09-01 21:07:22",
                "Id": "be32d91c-9ea3-4397-982e-fc9578142942",
                "Message": "Create Catalog Connection Success",
                "Name": "chenfan_test_1",
                "Operator": "700002744585",
                "Properties": [
                    {
                        "Key": "tclake.cos.credentials.server.url",
                        "Value": "http://21.215.50.237:2030/v1/internal/GetTcLakeFsToken"
                    }
                ],
                "Status": 2,
                "Type": "LAKEHOUSE",
                "UpdateTime": "2026-09-04 16:43:13"
            }
        ],
        "Total": 5,
        "RequestId": "a4aafbf9-b18c-44bf-a840-6e6bd4cd9029"
    }
}

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

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