调用DescribeDatabases接口查询PolarDB指定集群的数据库列表信息。

调试

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

请求参数

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

系统规定参数,取值为DescribeDatabases

DBClusterId String pc-**************

集群ID。

DBName String testdb

数据库名。

说明 不支持填入多个数据库名称。

返回数据

名称 类型 示例值 描述
Databases Array of Database

数据库组成的集合。

Database
Accounts Array of Account

账号组成的集合。

说明 不含高权限账号。
Account
AccountName String test_acc

账号名称。

说明 不含高权限账号。
AccountPrivilege String ReadIndex

账号权限,取值范围如下:

  • ReadWrite:读写
  • ReadOnly:只读
  • DMLOnly:只允许DML
  • DDLOnly:只允许DDL
  • ReadIndex:只读+索引
AccountStatus String Available

账号状态,取值范围如下:

  • Creating:创建中
  • Available:可用
  • Deleting:删除中
PrivilegeStatus String Empowered

授权状态,取值范围如下:

  • Empowering:授权中
  • Empowered:授权完成
  • Removing:移除权限中
CharacterSetName String utf8mb4

字符集,详情请参见字符集表

DBDescription String test_des

数据库备注。

DBName String testdb

数据库名称。

DBStatus String Running

数据库状态,取值范围如下:

  • Creating:创建中
  • Running:使用中
  • Deleting:删除中
Engine String POLARDB

数据库引擎。

RequestId String 6BD026D5-BF5B-4B4C-869C-7EB70F******

请求ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeDatabases
&DBClusterId=pc-**************
&<公共请求参数>

正常返回示例

XML 格式

<Databases>
    <Database>
        <CharacterSetName>utf8mb4</CharacterSetName>
        <DBDescription>test_des</DBDescription>
        <DBName>testdb</DBName>
        <DBStatus>Running</DBStatus>
        <Engine>POLARDB</Engine>
        <Accounts>
            <Account>
                <AccountStatus>Available</AccountStatus>
                <AccountPrivilege>ReadIndex</AccountPrivilege>
                <PrivilegeStatus>Empowered</PrivilegeStatus>
                <AccountName>test_acc</AccountName>
            </Account>
        </Accounts>
    </Database>
</Databases>
<RequestId>6BD026D5-BF5B-4B4C-869C-7EB70F******</RequestId>

JSON 格式

{
	"Databases": {
		"Database": [
			{
				"CharacterSetName": "utf8mb4",
				"DBDescription": "test_des",
				"DBName": "testdb",
				"DBStatus": "Running",
				"Engine": "POLARDB",
				"Accounts": {
					"Account": [
						{
							"AccountStatus": "Available",
							"AccountPrivilege": "ReadIndex",
							"PrivilegeStatus": "Empowered",
							"AccountName": "test_acc"
						}
					]
				}
			}
		]
	},
	"RequestId": "6BD026D5-BF5B-4B4C-869C-7EB70F******"
}

错误码

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