查询数据库列表

最近更新时间:2024-06-10 01:39:20

我的收藏

1. 接口描述

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

本接口(DescribeDatabases)用于查询数据库列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDatabases。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表
Limit Integer 返回数量,默认为10,最大值为100。
示例值:20
Offset Integer 数据偏移量,从0开始,默认为0。
示例值:0
KeyWord String 模糊匹配,库名关键字。
示例值:"data"
DatasourceConnectionName String 数据源唯名称,该名称可以通过DescribeDatasourceConnection接口查询到。默认为DataLakeCatalog
示例值:DataLakeCatalog
Sort String 排序字段,CreateTime:创建时间,Name:数据库名称
示例值:DatabaseName
Asc Boolean 排序类型:false:降序(默认)、true:升序
示例值:false

3. 输出参数

参数名称 类型 描述
DatabaseList Array of DatabaseResponseInfo 数据库对象列表。
TotalCount Integer 实例总数。
示例值:21
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询数据库列表

查询数据库列表

输入示例

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

{
    "DatasourceConnectionName": "DataLakeCatalog",
    "Limit": 1,
    "Offset": 0
}

输出示例

{
    "Response": {
        "DatabaseList": [
            {
                "DatabaseName": "abc",
                "Comment": "abc",
                "Properties": [
                    {
                        "Key": "abc",
                        "Value": "abc"
                    }
                ],
                "CreateTime": "abc",
                "ModifiedTime": "abc",
                "Location": "abc",
                "UserAlias": "abc",
                "UserSubUin": "abc",
                "GovernPolicy": {
                    "RuleType": "abc",
                    "GovernEngine": "abc"
                },
                "DatabaseId": "abc"
            }
        ],
        "TotalCount": 1,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.GovernError 数据治理错误,请重试,或者提交工单联系我们
FailedOperation.MetastoreError 元数据错误,请重试,或者提交工单联系我们
InternalError 内部错误。
InternalError.InternalSystemException 业务系统异常,请重试或提工单联系我们。
InvalidParameter 参数错误。
ResourceNotFound 资源不存在。
ResourceNotFound.DatasourceNotFound 数据源连接不存在,请重试,或者提交工单联系我们
UnsupportedOperation.UnsupportedDatasourceConnectionType 不支持当前数据连接类型,当前仅支持: DataLakeCatalog/Mysql/HiveCos/HiveHdfs/HiveCHdfs/PostgreSql/SqlServer/ClickHouse