调用DescribeAccountList接口查询实例的账号信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeAccountList |
系统规定参数。取值为DescribeAccountList。 |
| DBInstanceName | String | 是 | pxc-**************** |
实例ID。 |
| RegionId | String | 是 | cn-hangzhou |
实例所在地域。 |
| AccountName | String | 否 | test |
账号名称。
说明 该参数值为空时表示查询目标实例下的所有账号。
|
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Data | Array of Account |
账号信息。 |
|
| AccountDescription | String | test |
账号描述。 |
| AccountName | String | testname |
账号名称。 |
| AccountPrivilege | String | ReadWrite,ReadWrite |
账号权限列表，多个权限间用英文逗号（,）分隔。
说明 仅当账号类型为
0即普通账号时返回该参数。 |
| AccountType | String | 0 |
账号类型，取值范围如下：
|
| DBInstanceName | String | pxc-**************** |
实例ID。 |
| DBName | String | db1,db2 |
账号授权的数据库，多个数据库间用英文逗号（,）隔开。 |
| Message | String | **** |
请求返回消息。
说明 请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。
|
| RequestId | String | 9190A9EB-E866-4EE6-BD2C-B7EC46****** |
请求ID。 |
| Success | Boolean | true |
请求是否成功。 |
示例
请求示例
http(s)://polardbx.cn-hangzhou.aliyuncs.com/?Action=DescribeAccountList
&DBInstanceName=pxc-****************
&RegionId=cn-hangzhou
&<公共请求参数>正常返回示例
XML 格式
<Message/>
<RequestId>9190A9EB-E866-4EE6-BD2C-B7EC46******</RequestId>
<Data>
<AccountPrivilege>ReadWrite,ReadWrite</AccountPrivilege>
<DBName>db1,db2</DBName>
<AccountType>0</AccountType>
<AccountName>testname</AccountName>
<DBInstanceName>pxc-****************</DBInstanceName>
</Data>
<Data>
<AccountDescription>test</AccountDescription>
<AccountType>1</AccountType>
<AccountName>testname2</AccountName>
<DBInstanceName>pxc-****************</DBInstanceName>
</Data>
<Success>true</Success>JSON 格式
{
"Message": "",
"RequestId": "9190A9EB-E866-4EE6-BD2C-B7EC46******",
"Data": [{
"AccountPrivilege": "ReadWrite,ReadWrite",
"DBName": "db1,db2",
"AccountType": "0",
"AccountName": "testname",
"DBInstanceName": "pxc-****************"
}, {
"AccountDescription": "test",
"AccountType": "1",
"AccountName": "testname2",
"DBInstanceName": "pxc-****************"
}],
"Success": true
}错误码
访问错误中心查看更多错误码。
