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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDatabases

系统规定参数。取值:DescribeDatabases

DBInstanceId String rm-uf6wjk5xxxxxxx

实例ID。

DBName String testDB01

数据库名称。

DBStatus String Creating

数据库状态,取值:

  • Creating:创建中
  • Running:使用中
  • Deleting:删除中
PageSize Integer 30

每页记录数,取值:

  • 30
  • 50
  • 100

默认值:30。

PageNumber Integer 1

页码,取值:大于0且不超过Integer的最大值。

默认值:1

ResourceGroupId String rg-acfmy*****

资源组ID。

返回数据

名称 类型 示例值 描述
RequestId String 2603CA96-B17D-4903-BC04-61A2C829CD94

请求ID。

Databases Array of Database

数据库信息列表。

Database
DBDescription String 测试数据库

数据库描述。

DBStatus String Creating

数据库状态,返回值:

  • Creating:创建中
  • Running:使用中
  • Deleting:删除中
DBName String testDB01

数据库名称。

DBInstanceId String rm-uf6wjk5xxxxxxx

数据库所属实例ID。

Engine String MySQL

数据库实例类型。

CharacterSetName String utf8

字符集名称。

Collate String C

排序规则,此处C代表本土化。

说明 仅PostgreSQL实例返回该参数。
Ctype String en_US.utf8

字符集类型。

说明 仅PostgreSQL实例返回该参数。
ConnLimit String -1

限制并发量,-1代表未限制。

说明 仅PostgreSQL实例返回该参数。
Tablespace String pg_default

数据库表空间。

说明 仅PostgreSQL实例返回该参数。
ResourceGroupId String rg-acfmy*****

资源组ID。

Accounts Array of AccountPrivilegeInfo

拥有数据库相关权限的账号信息。

AccountPrivilegeInfo
Account String test

账号名称。

AccountPrivilege String DMLOnly

账号对该数据库拥有的权限,返回值:

  • ReadWrite:读写
  • ReadOnly:只读
  • DMLOnly:仅DML
  • DDLOnly:仅DDL
AccountPrivilegeDetail String SELECT

账号对该数据库具有的权限。

PageNumber Integer 1

预留字段。

PageSize Integer 30

预留字段。

TotalCount Integer 100

总记录数。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeDatabases
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeDatabasesResponse>
	<RequestId>2603CA96-B17D-4903-BC04-61A2C829CD94</RequestId>
	<Databases>
		<Database>
			<Engine>MySQL</Engine>
			<CharacterSetName>utf8</CharacterSetName>
			<DBStatus>Creating</DBStatus>
			<DBDescription></DBDescription>
			<DBInstanceId>rdsaiiabnaiiabn</DBInstanceId>
			<Accounts></Accounts>
			<DBName>testdb</DBName>
		</Database>
		<Database>
			<Engine>MySQL</Engine>
			<CharacterSetName>gbk</CharacterSetName>
			<DBStatus>Creating</DBStatus>
			<DBDescription></DBDescription>
			<DBInstanceId>rdsaiiabnaiiabn</DBInstanceId>
			<Accounts></Accounts>
			<DBName>testdb2</DBName>
		</Database>
	</Databases></DescribeDatabasesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "2603CA96-B17D-4903-BC04-61A2C829CD94",
  "Databases" : {
    "Database" : [ {
      "Engine" : "MySQL",
      "CharacterSetName" : "utf8",
      "DBStatus" : "Creating",
      "DBDescription" : "",
      "DBInstanceId" : "rdsaiiabnaiiabn",
      "Accounts" : {
        " AccountPrivilegeInfo" : [ ]
      },
      "DBName" : "testdb"
    }, {
      "Engine" : "MySQL",
      "CharacterSetName" : "gbk",
      "DBStatus" : "Creating",
      "DBDescription" : "",
      "DBInstanceId" : "rdsaiiabnaiiabn",
      "Accounts" : {
        " AccountPrivilegeInfo" : [ ]
      },
      "DBName" : "testdb2"
    } ]
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 Database.ConnectError Database connect error. please check instance status and database processlist 数据库连接异常,请检查实例状态及数据库的连接池
400 Database.QueryError Query Db failed, please check input value and instance status 查询数据库失败, 请检查输入参数及实例状态

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