通过参数查询数据库模式列表

最近更新时间:2025-10-13 02:43:15

我的收藏

1. 接口描述

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

获取资产数据库Schema信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ListSchema。
Version String 公共参数,本接口取值:2025-08-06。
Region String 公共参数,详见产品支持的 地域列表
PageNumber Integer 页码,从1开始
示例值:1
PageSize Integer 分页大小,最大500
示例值:10
CatalogName String 目录名称
示例值:0
DatasourceId Integer 数据源ID
示例值:8499
DatabaseName String 数据库名称
示例值:orcl
Keyword String 数据库模式搜索关键字
示例值:dev

3. 输出参数

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

4. 示例

示例1 查询Schema列表

查询Schema列表

输入示例

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

{
    "PageNumber": 1,
    "PageSize": 10,
    "CatalogName": "0",
    "DatasourceId": 8499,
    "DatabaseName": "orcl",
    "Keyword": "dev"
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "DatabaseName": "orcl",
                    "Guid": "RpMuByxDK0C22iZeDOBMsA",
                    "Name": "WEDATA_DEV"
                }
            ],
            "PageCount": 0,
            "PageNumber": 1,
            "PageSize": 1,
            "TotalCount": 1
        },
        "RequestId": "283e76af-5333-4fe8-a968-b0370092e0cf"
    }
}

示例2 OpenAPI-查询数据库Schema

OpenAPI-查询数据库Schema

输入示例

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

{
    "PageNumber": 1,
    "PageSize": 2,
    "Keyword": "tab"
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "DatabaseName": "my_database",
                    "Guid": "oJRdeGawTgyfMhtn8yvxHA",
                    "Name": "my_database"
                },
                {
                    "DatabaseName": "table_datatbases",
                    "Guid": "NJovXubQQXmb6cao__HYdA",
                    "Name": "table_datatbases"
                }
            ],
            "PageCount": 0,
            "PageNumber": 1,
            "PageSize": 2,
            "TotalCount": 4
        },
        "RequestId": "c6781fb3-5516-4a9b-ba06-2181481cd5ea"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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