数据开发治理平台 WeData 实时获取数据库列表信息

1. 接口描述

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

离线通过表名称获取表信息

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeRealViewDatabasePage。
Version	是	String	公共参数，本接口取值：2021-08-20。
Region	是	String	公共参数，详见产品支持的地域列表。
DatasourceId	是	Integer	数据源ID 示例值：10
ProjectId	是	String	项目Id 示例值：1000
Asc	否	Boolean	排序字段类型：ASC/DESC 示例值：true
ConnectionType	否	String	指定数据源链接方式，如hive jdbc或者metastore client 示例值：rpc
Keyword	否	String	Keyword过滤示例值：关键字
PageNumber	否	Integer	【分页参数】页码示例值：1
PageSize	否	Integer	【分页参数】分页大小示例值：10
ResourceGroupId	否	String	资源组ID 示例值：100
ResourceType	否	Integer	资源组类型示例值：1
Sort	否	String	Sort 示例值：sort
CatalogName	否	String	catalog名称示例值：internal

3. 输出参数

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

4. 示例

示例1 DescribeRealViewDatabasePage

输入示例

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

{
    "DatasourceId": 0,
    "ProjectId": "a1b1c",
    "Asc": true,
    "ConnectionType": "a1b1c",
    "Keyword": "a1b1c",
    "PageNumber": 0,
    "PageSize": 0,
    "ResourceGroupId": "a1bc1",
    "ResourceType": 0,
    "Sort": "a1b1c"
}

输出示例

{
    "Response": {
        "Data": {
            "PageNumber": 1,
            "PageSize": 2,
            "Rows": [
                {
                    "DataSourceId": 8575,
                    "DataSourceName": "di_doris",
                    "DataSourceType": "DORIS",
                    "DatabaseName": "cockpit"
                },
                {
                    "DataSourceId": 8575,
                    "DataSourceName": "di_doris",
                    "DataSourceType": "DORIS",
                    "DatabaseName": "db_01"
                }
            ],
            "TotalCount": 816,
            "TotalPageNumber": 408
        },
        "RequestId": "99a63938-9900-4fac-ab37-3d7f14e95007"
    }
}

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

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

错误码	描述
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。

实时获取数据库列表信息

本页目录：