查询数据库列表

最近更新时间:2024-03-12 01:47:14

我的收藏

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDatabases。
Version String 公共参数,本接口取值:2018-03-28。
Region String 公共参数,详见产品支持的 地域列表
InstanceIdSet.N Array of String 实例ID
示例值:["mssql-njj2mtpl\r\n"]
Limit Integer 分页返回,每页返回的数目,取值为1-100,默认值为20
示例值:10
Offset Integer 分页返回,页编号,默认值为第0页
示例值:0
Name String 数据库名称
示例值:test_db
OrderByType String 排序规则(desc-降序,asc-升序),默认desc
示例值:desc
Encryption String 是否已开启TDE加密,enable-已加密,disable-未加密
示例值:disable

3. 输出参数

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

4. 示例

示例1 查询数据库列表

查询数据库列表

输入示例

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

{
    "InstanceIdSet": [
        "mssql-ds3p26cv"
    ]
}

输出示例

{
    "Response": {
        "DBInstances": [
            {
                "DBDetails": [
                    {
                        "Accounts": [
                            {
                                "AccountType": "L3",
                                "Privilege": "ReadWrite",
                                "UserName": "L2"
                            },
                            {
                                "AccountType": "L1",
                                "Privilege": "DBOwner",
                                "UserName": "L0"
                            }
                        ],
                        "Charset": "Chinese_PRC_CI_AS",
                        "CreateTime": "2023-09-21 21:37:47",
                        "Encryption": "disable",
                        "InternalStatus": "ONLINE",
                        "Name": "test_db3",
                        "Remark": "--",
                        "Status": 2
                    },
                    {
                        "Accounts": [
                            {
                                "AccountType": "L3",
                                "Privilege": "ReadOnly",
                                "UserName": "L3"
                            },
                            {
                                "AccountType": "L3",
                                "Privilege": "ReadOnly",
                                "UserName": "L2"
                            },
                            {
                                "AccountType": "L1",
                                "Privilege": "DBOwner",
                                "UserName": "L0"
                            }
                        ],
                        "Charset": "Chinese_PRC_CI_AS",
                        "CreateTime": "2023-09-21 15:49:48",
                        "Encryption": "disable",
                        "InternalStatus": "ONLINE",
                        "Name": "test_db2",
                        "Remark": "--",
                        "Status": 2
                    },
                    {
                        "Accounts": [
                            {
                                "AccountType": "L3",
                                "Privilege": "ReadWrite",
                                "UserName": "L3"
                            },
                            {
                                "AccountType": "L3",
                                "Privilege": "ReadWrite",
                                "UserName": "L2"
                            },
                            {
                                "AccountType": "L1",
                                "Privilege": "DBOwner",
                                "UserName": "L0"
                            }
                        ],
                        "Charset": "Chinese_PRC_CI_AS",
                        "CreateTime": "2023-09-20 20:21:50",
                        "Encryption": "disable",
                        "InternalStatus": "ONLINE",
                        "Name": "test_db",
                        "Remark": "--",
                        "Status": 2
                    }
                ],
                "InstanceId": "mssql-ds3p26cv"
            }
        ],
        "RequestId": "1e4e038e-76eb-11ee-b611-525400853186",
        "TotalCount": 3
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DBError 数据库错误。
FailedOperation.GcsError 操作失败或者网络超时。
InternalError.SystemError 系统错误。
InvalidParameter.InputIllegal 输入错误。
InvalidParameter.ParamsAssertFailed 参数断言转换错误。
ResourceNotFound.InstanceNotFound 实例不存在。
UnauthorizedOperation.PermissionDenied cam鉴权错误。