DescribeDatabases
该接口用于查询POLARDB指定集群的数据库列表信息。
如果查询参数类型错误,将返回错误提示,返回数据为空。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DBClusterId | String | 是 | pc-xxxxxxxxxxxxxxx |
集群ID。 |
AccessKeyId | String | 否 | key-test |
阿里云颁发给用户的访问服务所用的密钥ID。 |
Action | String | 否 | DescribeDatabases |
系统规定参数,取值:DescribeDatabases。 |
DBName | String | 否 | test_db_4 |
数据库名。 说明 不支持填入多个数据库名称。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Databases | Array |
数据库组成的集合。 |
|
Database |
数据库组成的集合。 |
||
Accounts | Array |
账号组成的集合。 说明 不含高权限账号。
|
|
Account |
账号组成的集合。 说明 不含高权限账号。
|
||
AccountName | String | test_admin |
账号名。 说明 不含高权限账号。
|
AccountPrivilege | String | ReadWrite |
账号权限。
|
AccountStatus | String | Available |
账号状态:
|
PrivilegeStatus | String | Empowered |
授权状态:
|
CharacterSetName | String | utf8 |
字符集,参见字符集表。 |
DBDescription | String | test_db |
数据库备注。 |
DBName | String | test_db_4 |
数据库名。 |
DBStatus | String | Running |
数据库状态:
|
Engine | String | POLARDB |
引擎。 |
RequestId | String | EB88083B-AEE7-44B1-9AEB-E76337B1B236 |
请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeDatabases
&DBClusterId=pc-xxxxxxxxxxxxxxx
&<公共请求参数>
正常返回示例
XML
格式
<DescribeDatabasesResponse>
<Databases>
<Database>
<Accounts>
<Account>
<AccountPrivilege>ReadWrite</AccountPrivilege>
<AccountStatus>Available</AccountStatus>
<AccountName>test_admin</AccountName>
<PrivilegeStatus>Empowered</PrivilegeStatus>
</Account>
</Accounts>
<DBStatus>Running</DBStatus>
<DBDescription></DBDescription>
<DBName>test_db_4</DBName>
<Engine>POLARDB</Engine>
<CharacterSetName>utf8</CharacterSetName>
</Database>
</Databases>
<RequestId>6A83E8E9-D5C4-45CE-85CD-B0A3B2F21F5E</RequestId>
</DescribeDatabasesResponse>
JSON
格式
{
"successResponse":true,
"requestId":"EB88083B-AEE7-44B1-9AEB-E76337B1B236",
"data":{
"Databases":{
"Database":[
{
"Accounts":{
"Account":[
{
"AccountPrivilege":"ReadWrite",
"AccountStatus":"Available",
"AccountName":"test_a",
"PrivilegeStatus":"Empowered"
},
{
"AccountPrivilege":"ReadOnly",
"AccountStatus":"Available",
"AccountName":"test_acc",
"PrivilegeStatus":"Empowered"
}
]
},
"DBStatus":"Running",
"DBDescription":"",
"DBName":"test_db_2",
"Engine":"POLARDB",
"CharacterSetName":"utf8"
},
{
"Accounts":{
"Account":[
{
"AccountPrivilege":"ReadWrite",
"AccountStatus":"Available",
"AccountName":"test_acc",
"PrivilegeStatus":"Empowered"
}
]
},
"DBStatus":"Running",
"DBDescription":"",
"DBName":"test_db_5",
"Engine":"POLARDB",
"CharacterSetName":"utf8mb4"
}
]
},
"RequestId":"EB88083B-AEE7-44B1-9AEB-E76337B1B236"
},
"code":"200"
}
错误码
访问错误中心查看更多错误码。
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论