该接口用于查询指定集群、指定数据库的账号列表信息或某个指定账号的信息。

请求参数

名称 类型 是否必须 描述
Action String 系统规定参数,取值:DescribeAccounts。
DBClusterId String 集群ID。
AccountName String 账号名。
PageSize Integer 每页记录数,取值:
  • 30;
  • 50;
  • 100;
  • 默认值:30。
PageNumber Integer 页码,取值为:大于0且不超过Integer数据类型的最大值,默认值为1。

返回参数

名称 类型 描述
<公共返回参数> - 详见公共参数
Accounts List<Account> 账号组成的集合。
PageNumber Integer 页数。
TotalCount Integer 总记录数。
PageSize Integer 总页数。

Account参数

名称 类型 描述
AccountName String 账号名。
AccountStatus String 账号状态:
  • Creating:创建中;
  • Available:可用;
  • Deleting:删除中。
AccountDescription String 账号备注。
AccountType String

账户类型:

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

示例

请求示例

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

正常返回示例

XML 格式

<DescribeAccountsResponse>  
    <RequestId>64E37E6F-C363-41F3-867A-70EF5DC60EA4</RequestId>
    <Accounts>
        <Account>
            <AccountStatus>Available</AccountStatus>
            <AccountDescription></AccountDescription>
            <AccountName>test_accout</AccountName>
            <AccountType>Super</AccountType>
        </Account>
    </Accounts>
  <PageNumber>1</PageNumber>
  <TotalCount>1</TotalCount>
  <PageSize>30</PageSize>
</DescribeAccountsResponse>

JSON 格式

{
  "RequestId": "64E37E6F-C363-41F3-867A-70EF5DC60EA4",
  "Accounts": {
    "Account": [
      {
        "AccountStatus": "Available",
        "AccountDescription": "",
        "AccountName": "test_accout",
        "AccountType": "Super"
      }
    ]
  },
  "PageNumber": 1,
  "TotalCount": 1,
  "PageSize": 30
}