数据开发治理平台 WeData 根据数据库名称和数据源id获取数

1. 接口描述

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

根据数据库名称和数据源id获取数据库信息

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDatabaseByName。
Version	是	String	公共参数，本接口取值：2021-08-20。
Region	是	String	公共参数，详见产品支持的地域列表。
DatabaseName	是	String	数据库名称示例值：db_name
DatasourceId	是	Integer	数据源id 示例值：4506
SchemaName	否	String	schema名称示例值：public
ClusterId	否	String	集群id 示例值：emr-xd

3. 输出参数

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

4. 示例

示例1 根据数据库名称查询数据库信息

根据数据库名称查询数据库信息

输入示例

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

{
    "DatabaseName": "atta_boss",
    "DatasourceId": 146721,
    "SchemaName": null,
    "ClusterId": null
}

输出示例

{
    "Response": {
        "RequestId": "req_id_***",
        "DatabaseMeta": {
            "DatabaseId": null,
            "DatabaseGuid": null,
            "DatabaseName": "atta_boss",
            "ProjectId": "project_id_***",
            "ProjectName": "project_eng_name",
            "ProjectDisplayName": "项目中文名称",
            "MetastoreType": "DLC",
            "DatasourceId": 146721,
            "DatasourceName": "dlc_***",
            "DisplayName": "dlc_***.atta_boss",
            "Category": "CLUSTER",
            "Catalog": "DataLakeCatalog",
            "Description": "员工域数据",
            "Instance": "fkiqo0om",
            "OwnerAccount": 100000123456,
            "OwnerAccountName": "root",
            "Region": "ap-guangzhou",
            "Status": 1,
            "StorageSize": 536870912,
            "StorageSizeWithUnit": "512.00MB",
            "CreateTime": "2023-03-09 15:42:59",
            "TableCount": 12,
            "DatasourceList": [
                {
                    "DatasourceId": "146721",
                    "DatasourceName": "dlc_***",
                    "DatasourceClusterId": "fkiqo0om",
                    "DatasourceUrn": "dlc_***",
                    "DatasourceEnv": "production"
                }
            ],
            "CollectJobId": "collect_job_***",
            "CollectJobName": "dlc_采集任务",
            "ClusterId": "fkiqo0om",
            "ClusterName": "DLC实例-***",
            "OperateOption": null,
            "ModifiedTimeByTables": 1770625474000,
            "LastAccessTimeByTables": 1770625474000
        }
    }
}

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

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