云数据库 RDS

产品文档

云数据库 RDS

describeDatabases

描述

获取当前实例的所有数据库详细信息的列表

请求方式

GET

请求地址

https://rds.jdcloud-api.com/v1/regions/{regionId}/instances/{instanceId}/databases

名称 类型 是否必需 默认值 描述
regionId String True 地域代码,取值范围参见《各地域及可用区对照表》
instanceId String True RDS 实例ID,唯一标识一个RDS实例

请求参数

名称 类型 是否必需 默认值 描述
dbName String False 数据库名。如果不指定数据库名,则返回所有数据库列表
- MySQL:不支持该字段
- SQL Server:支持该字段
pageNumber Integer False 显示数据的页码,默认为1,取值范围:[-1,∞)。pageNumber为-1时,返回所有数据页码;超过总页数时,显示最后一页;
pageSize Integer False 每页显示的数据条数,默认为100,取值范围:[10,100],用于查询列表的接口

返回参数

名称 类型 描述
result Result

Result

名称 类型 描述
databases Database[ ]
totalCount Integer

Database

名称 类型 描述
dbName String 数据库名称,具体规则可参见帮助中心文档:名称及密码限制
dbStatus String 数据库状态,参见枚举参数定义
- MySQL:不支持,不返回该字段
- SQL Server:返回该字段
characterSetName String 字符集,参见枚举参数定义
createTime String 数据库创建时间,格式YYYY-MM-DD HH:mm:ss
- 仅支持SQL Server
accessPrivilege DBAccessPrivilege[ ] 该数据库相关账户权限列表

DBAccessPrivilege

名称 类型 描述
accountName String 账号名称
privilege String 该账号对数据库具有的权限,权限的具体定义可以参见枚举参数定义

返回码

返回码 描述
200 OK

请求示例

GET

public void testDescribeDatabases() {
    DescribeDatabasesRequest request = new DescribeDatabasesRequest();
    request.setRegionId("cn-north-1");
    request.setInstanceId("mysql-wp4e9ztap2");
    DescribeDatabasesResponse response = rdsClient.describeDatabases(request);
    System.out.println(new Gson().toJson(response));
}

返回示例

{
    "requestId": "bpa3nt4613954dn6hp9k8d1wc4f5prwp", 
    "result": {
        "databases": [
            {
                "accessPrivilege": [
                    {
                        "accountName": "ac", 
                        "privilege": "rw"
                    }, 
                    {
                        "accountName": "dj_ac", 
                        "privilege": "rw"
                    }
                ], 
                "characterSetName": "utf8", 
                "dbName": "dj_db"
            }, 
            {
                "accessPrivilege": [ ], 
                "characterSetName": "utf8", 
                "dbName": "test_db"
            }
        ], 
        "totalCount": 2
    }
}
更新时间:2020-01-19 16:57:35
feedback