查询数据库

最近更新时间:2017-12-14 10:47:56

1. 接口描述

本接口(QueryCdbDatabases)用于查询云数据库实例的数据库信息。
接口请求域名:cdb.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为QueryCdbDatabases。

参数名称 是否必选 类型 描述
cdbInstanceIds.n String 一个或者多个实例ID,n表示从0开始的数组下标。实例ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同,可使用查询实例列表 接口获取,其值为输出参数中字段 uInstanceId 的值。

3. 输出参数

参数名称 类型 描述
code Int 公共错误码, 0表示成功,其他值表示失败。详见错误码页面的公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误描述
data Array 返回实例的数据库数据

其中, data 参数的元素构成如下:

参数名称 类型 描述
code Int 查询数据库错误码
message String 查询数据库错误信息
cdbInstanceId String 实例ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同,可使用查询实例列表 接口获取,其值为输出参数中字段 uInstanceId 的值。
databaseList Array 数据库信息列表

4. 错误码表

以下错误码表列出了该接口的业务逻辑错误码。

错误码 英文错误码 描述
9003 InvalidParameter 参数错误

5. 示例

输入

https://cdb.api.qcloud.com/v2/index.php?Action=QueryCdbDatabases
&<公共请求参数>
&cdbInstanceIds.0=cdb-f35wr6wj

输出

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": [
        {
            "code": 0,
            "message": "ok",
            "cdbInstanceId": "cdb-f35wr6wj",
            "databaseList": [
                "information_schema",
                "mysql",
                "performance_schema",
                "test"
            ],
        }
    ]
}