帮你快速理解、总结文档立即下载
文档中心>数据湖计算 DLC>API 文档>AI DLC 数据目录相关接口>分页查询 Catalog 下 Schema 列表

分页查询 Catalog 下 Schema 列表

最近更新时间：2026-09-24 02:01:53
我的收藏

本页目录：

1. 接口描述

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

分页查询 Catalog 下 Schema 列表

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

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

2. 输入参数

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

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

数据目录名称


示例值：chenfan_test_1
Limit 否 Integer

分页大小


示例值：1000
Offset 否 Integer

分页偏移


示例值：0
SnapshotBased 否 Boolean

是否快照分页


示例值：true
SnapshotId 否 String

快照 ID


示例值：SnapshotId
SchemaNamePattern 否 String

SQL查询格式匹配


示例值：table*

3. 输出参数

参数名称 类型 描述
SchemaNames Array of NameIdentifier

数据库名称列表
TotalCount Integer

总数


示例值：3
SnapshotId String

快照 ID


示例值：SnapshotId
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例1

输入示例

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

{
    "CatalogName": "chenfan_test_1",
    "Limit": 1000
}

输出示例

{
    "Response": {
        "SchemaNames": [
            {
                "Name": "default",
                "Namespace": [
                    "chenfan_test_1"
                ]
            }
        ],
        "TotalCount": 3,
        "SnapshotId": "",
        "RequestId": "dca17bf4-111c-48aa-b995-8a210e180cea"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

中国站