查询数据库模式

最近更新时间:2017-12-14 10:52:23

1. 接口描述

本接口(GetCdbInstanceSchema)用于查询数据库的模式详情。如果未设置可选参数dbName和tbName,返回数据库实例中除系统库之外的库列表;如果只设置了dbName,返回dbName库下的所有table的列表;如果同时设置了dbName和tbName,返回dbName库中tbName表中所有的列信息。
接口请求域名:cdb.api.qcloud.com

2. 输入参数

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

参数名称 是否必选 类型 描述
cdbInstanceId String 实例ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同,可使用查询实例列表 接口获取,其值为输出参数中字段 uInstanceId 的值。
dbName String 需要查询模式的数据库的名称
tbName String 需要查询模式的表格的名称,如果指定了tbName则dbName也必须指定

3. 输出参数

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

4. 错误码表

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

错误码 英文错误码 描述
9003 InvalidParameter 参数错误
9531 ConnectRefused 连接实例被拒绝
9532 ConnectErrorUnknown 连接实例错误
9533 SqlExecFailUnknown 数据库操作失败
9572 InstanceNotExists 实例不存在

5. 示例

输入

https://cdb.api.qcloud.com/v2/index.php?Action=GetCdbInstanceSchema
&<公共请求参数>
&cdbInstanceId=cdb-ainl9ibe

输出

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": [
        "test"
    ]
}