查询数据库元数据

最近更新时间:2026-03-18 03:58:57

我的收藏

1. 接口描述

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

根据数据库Id查询数据库元数据,带有数据源和项目信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDatabaseMeta。
Version String 公共参数,本接口取值:2021-08-20。
Region String 公共参数,详见产品支持的 地域列表
DatabaseId String 数据源唯一Id
示例值:guid

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: DescribeDatabaseMeta
<公共请求参数>

{
    "DatabaseId": "guid_of_database_***"
}

输出示例

{
    "Response": {
        "RequestId": "req_id_***",
        "DatabaseMeta": {
            "DatabaseId": null,
            "DatabaseGuid": "guid_of_database_***",
            "DatabaseName": "example_db",
            "ProjectId": "project_id_***",
            "ProjectName": "project_eng_name",
            "ProjectDisplayName": "项目中文名称",
            "MetastoreType": "HIVE",
            "DatasourceId": 79541,
            "DatasourceName": "hive_emr-***",
            "DisplayName": "hive_emr-***.example_db",
            "Category": "CLUSTER",
            "Catalog": "hive",
            "Description": "业务数据库",
            "Instance": "emr-***",
            "OwnerAccount": 100000,
            "OwnerAccountName": "hadoop",
            "Region": "ap-guangzhou",
            "Status": 1,
            "StorageSize": 1073741824,
            "StorageSizeWithUnit": "1.00GB",
            "CreateTime": "2023-03-09 15:42:59",
            "TableCount": 56,
            "DatasourceList": [
                {
                    "DatasourceId": "79541",
                    "DatasourceName": "hive_emr-***",
                    "DatasourceClusterId": "emr-***",
                    "DatasourceUrn": "hive_emr-***",
                    "DatasourceEnv": "production"
                }
            ],
            "CollectJobId": "collect_job_***",
            "CollectJobName": "hive_采集任务",
            "ClusterId": "emr-***",
            "ClusterName": "EMR-***集群",
            "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。

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.SignatureExpire 未登录或登录已过期。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.DataEngineInstanceNotExists 数据引擎实例不存在。
MissingParameter 缺少参数错误。