DescribeDatabases - 查看实例下的数据库信息 - 云数据库 RDS

调用DescribeDatabases接口查询RDS实例下的数据库信息。

接口说明

说明如果请求参数错误，返回数据为空。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
rds:DescribeDatabases	READ	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例ID。	rm-uf6wjk5xxxxxxx
DBName	string	否	数据库名称。	testDB01
DBStatus	string	否	数据库状态，取值： Creating：创建中 Running：使用中 Deleting：删除中	Creating
PageSize	integer	否	每页记录数，取值： 30 50 100 默认值：30。	30
PageNumber	integer	否	页码，取值：大于0且不超过Integer的最大值。默认值：1。	1
ResourceGroupId	string	否	资源组ID。	rg-acfmy*****

返回参数

名称	类型	描述	示例值
	object	返回参数如下。
RequestId	string	请求ID。	2603CA96-B17D-4903-BC04-61A2C829CD94
Databases	array	数据库信息列表。
	object	返回值如下。
DBDescription	string	数据库描述。	测试数据库
DBStatus	string	数据库状态，返回值： Creating：创建中 Running：使用中 Deleting：删除中	Creating
DBName	string	数据库名称。	testDB01
DBInstanceId	string	数据库所属实例ID。	rm-uf6wjk5xxxxxxx
Engine	string	数据库实例类型。	MySQL
CharacterSetName	string	字符集名称。	utf8
Collate	string	排序规则，此处C代表本土化。说明仅PostgreSQL实例返回该参数。	C
Ctype	string	字符集类型。说明仅PostgreSQL实例返回该参数。	en_US.utf8
ConnLimit	string	限制并发量，-1代表未限制。说明仅PostgreSQL实例返回该参数。	-1
Tablespace	string	数据库表空间。说明仅PostgreSQL实例返回该参数。	pg_default
ResourceGroupId	string	资源组ID。	rg-acfmy*****
Accounts	array	拥有数据库相关权限的账号信息。
	object	账号详情如下。
Account	string	账号名称。	test
AccountPrivilege	string	账号对该数据库拥有的权限，返回值： ReadWrite：读写 ReadOnly：只读 DMLOnly：仅DML DDLOnly：仅DDL	DMLOnly
AccountPrivilegeDetail	string	账号对该数据库具有的权限。	SELECT
PageNumber	integer	预留字段。	1
PageSize	integer	预留字段。	30
TotalCount	integer	总记录数。	100

示例

正常返回示例

JSON格式

{
  "RequestId": "2603CA96-B17D-4903-BC04-61A2C829CD94",
  "Databases": {
    "Database": [
      {
        "DBDescription": "测试数据库",
        "DBStatus": "Creating",
        "DBName": "testDB01",
        "DBInstanceId": "rm-uf6wjk5xxxxxxx",
        "Engine": "MySQL",
        "CharacterSetName": "utf8",
        "Collate": "C",
        "Ctype": "en_US.utf8",
        "ConnLimit": "-1",
        "Tablespace": "pg_default",
        "ResourceGroupId": "rg-acfmy*****",
        "Accounts": {
          "AccountPrivilegeInfo": [
            {
              "Account": "test",
              "AccountPrivilege": "DMLOnly",
              "AccountPrivilegeDetail": "SELECT"
            }
          ]
        },
        "PageNumber": 1,
        "PageSize": 30,
        "TotalCount": 100
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Database.ConnectError	Database connect error. please check instance status and database processlist	数据库连接异常，请检查实例状态及数据库的连接池
400	InvalidDBInstanceStatus.NotSupport	The Specified instance status is not supported to query account list.	-
400	Database.QueryError	Query Db failed, please check input value and instance status.	查询数据库失败，请检查输入参数及实例状态。

访问错误中心查看更多错误码。

变更历史

变更时间

变更内容概要

操作

2023-01-06

OpenAPI 错误码发生变更

变更项	变更内容
错误码	OpenAPI 错误码发生变更
	删除错误码：400

2022-09-15

OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更

变更项	变更内容
错误码	OpenAPI 错误码发生变更
	删除错误码：400
出参	OpenAPI 返回结构发生变更

2022-09-15

OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更

变更项	变更内容
错误码	OpenAPI 错误码发生变更
	删除错误码：400
出参	OpenAPI 返回结构发生变更