文档中心 > API类目 > 聚石塔API

taobao.rds.db.get (查询rds下的数据库)

查询rds实例下的数据库

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
instance_name String 必须 ins_123aa34bb
  • 最大长度:30
  • rds的实例名
    db_status Number 可选 1
  • 默认值:1
  • 最小值:0
  • 最大值:3
  • 最大长度:1
  • 数据库状态,默认值1

    响应参数

    名称 类型 示例值 描述
    rds_db_infos RdsDbInfo [] 数据库查询返回数据结构
    • └ max_account
    • String
    • 1
    • 最大帐号数,1个数据库最多可以创建的账户数目
    • └ db_status
    • String
    • 1
    • 数据库状态 0:创建中 ;1:激活;3:正在删除
    • └ charset
    • String
    • utf-8
    • 数据库编码
    • └ db_name
    • String
    • test
    • 数据库名称
    • └ instance_name
    • String
    • ins_xxx
    • rds实例名
    • └ instance_type
    • String
    • mysql
    • rds实例类型,s:共享型,x:专享型
    • └ db_type
    • String
    • mysql
    • 数据库类型,mysql或者mssql
    • └ comment
    • String
    • 备注
    • 备注

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    RdsDbGetRequest req = new RdsDbGetRequest();
    req.setInstanceName("ins_123aa34bb");
    req.setDbStatus(1L);
    RdsDbGetResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <rds_db_get_response>
        <rds_db_infos>
            <rds_db_info>
                <max_account>1</max_account>
                <db_status>1</db_status>
                <charset>utf-8</charset>
                <db_name>test</db_name>
                <instance_name>ins_xxx</instance_name>
                <instance_type>mysql</instance_type>
                <db_type>mysql</db_type>
                <comment>备注</comment>
            </rds_db_info>
        </rds_db_infos>
    </rds_db_get_response>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案
    isv.user-not-login 用户未登录 需要用户登录
    isv.appkey-empty appkey不能为空 appkey是top自动获取
    isv.instance-name-empty rds实例名称不能为空 入参输入实例名
    isv.instance-name:invalid-instance-name 实例名无效,查不到相关记录 入参输入正确的实例名
    isv.instance-name:rds-not-running 没有生产成功的rds 等待rds生产成功
    isp.get-resource-error 查询rds记录失败 稍后重试
    isv.record-no-permission 当前isv不能查看其他人的记录 isv由top自动获取
    isv.appkey-no-permission 当前appkey和rds绑定的appkey不匹配 appkey由top自动获取
    isp.huijin-error 汇金查询rds编号失败 稍后重试
    isp.wanwang-error 万网接口错误 稍后重试
    isp.dblist-empty 未查到数据库信息 稍后重试
    isp.system-error 系统异常 稍后重试

    API工具

    如何获得此API

    FAQ

    返回
    顶部