帮你快速理解、总结文档立即下载

获取数据库名称列表

最近更新时间:2026-10-26 01:56:51
我的收藏

1. 接口描述

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

分页查询数据库名称列表

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

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

2. 输入参数

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

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

数据目录名,必填


示例值:xzp_test
WorkspaceId 是 String

调用时所在workspace唯一id,必填


示例值:17899589369776893
MaxResults 否 String

最大结果条数,可选,默认10


示例值:1000
PageToken 否 String

分页token信息(base64编码,包含offset、snapshotId等)


示例值:token123
ConnectionId 否 String

数据源连接ID,可选(融合版新增字段)


示例值:a1b85c4d-67e1-4915-9822-9f1cb88ed4f3
CatalogSource 否 String

数据目录来源,取值参考CatalogSourceEnum:METALAKE/CONNECTION/SETATS


示例值:SETATS

3. 输出参数

参数名称 类型 描述
Data ListSchemaNamesRsp

返回结果


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

4. 示例

示例1 1

输入示例

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

{
    "MaxResults": "1000",
    "WorkspaceId": "17899589369776893",
    "CatalogName": "xzp_test",
    "CatalogSource": "SETATS"
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "Name": "0924_demo",
                    "Namespace": [],
                    "CatalogSource": "SETATS"
                }
            ],
            "NextPageToken": ""
        },
        "RequestId": "05890671-4e3a-4168-80b1-14fb10c872ea"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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