该接口用于查询PolarDB集群的数据库账号信息。

调试

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

请求参数

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

系统规定参数,取值:DescribeAccounts

DBClusterId String pc-xxxxxxxxxxxxxxx

集群ID。

AccountName String testacc

账号名称。

返回数据

名称 类型 示例值 描述
Accounts Array

账号组成的集合。

AccountDescription String AccDesc

账号备注。

AccountLockState String UnLock

账号锁定状态:

  • UnLock:未锁定。
  • Lock:锁定。
AccountName String testacc

账号名。

AccountPasswordValidTime String 2020-04-30T16:00:00Z

密码过期时间。

AccountStatus String Available

账号状态:

  • Creating:创建中。
  • Available:可用。
  • Deleting:删除中。
AccountType String Normal

账户类型:

  • Normal:普通账号。
  • Super:高权限账号。
DatabasePrivileges Array

账号拥有的数据库权限列表。

说明 仅限普通账号,不包括高权限账号。
AccountPrivilege String ReadOnly

账号权限。

DBName String DBtest

数据库名称。

RequestId String 16B29387-7226-4E6C-98C2-06B98FFD16D8

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeAccounts
&DBClusterId=pc-xxxxxxxxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<Accounts>
    <DatabasePrivileges>
        <AccountPrivilege>ReadWrite</AccountPrivilege>
        <DBName>test2</DBName>
    </DatabasePrivileges>
    <DatabasePrivileges>
        <AccountPrivilege>ReadOnly</AccountPrivilege>
        <DBName>test3</DBName>
    </DatabasePrivileges>
    <AccountStatus>Available</AccountStatus>
    <AccountDescription/>
    <AccountName>mytest1</AccountName>
    <PrivilegeExceeded>No</PrivilegeExceeded>
    <AccountLockState>UnLock</AccountLockState>
    <AccountType>Normal</AccountType>
</Accounts>
<RequestId>F0633414-8524-4215-B0A0-789A65A0D9ED</RequestId>

JSON 格式

{
	"Accounts": [
		{
			"DatabasePrivileges": [
				{
					"AccountPrivilege": "ReadWrite",
					"DBName": "test2"
				},
				{
					"AccountPrivilege": "ReadOnly",
					"DBName": "test3"
				}
			],
			"AccountStatus": "Available",
			"AccountDescription": "",
			"AccountName": "mytest1",
			"PrivilegeExceeded": "No",
			"AccountLockState": "UnLock",
			"AccountType": "Normal"
		}
	],
	"RequestId": "F0633414-8524-4215-B0A0-789A65A0D9ED"
}

错误码

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