You can call this operation to query the database accounts or a specified database account of a specified cluster.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to DescribeAccounts.
DBClusterId String Yes The ID of the cluster.
AccountName String No The name of the account.
PageSize Integer No The number of entries to return on each page. Valid values:
  • 30
  • 50
  • 100
  • Default value: 30.
PageNumber Integer No The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.

Response parameters

Parameter Type Description
<Common response parameters> - For more information, see Common parameters.
Accounts List<Account> The list of accounts.
PageNumber Integer The number of the returned page.
TotalCount Integer The total number of accounts.
PageSize Integer The total number of returned pages.

Account parameters

Parameter Type Description
AccountName String The name of the account.
AccountStatus String The status of the account. Valid values:
  • Creating: The account is being created.
  • Available: The account is available.
  • Deleting: The account is being deleted.
AccountDescription String The description of the account.
AccountType String

The type of the account. Valid values:

  • Normal: indicates a standard account.
  • Super: indicates a privileged account.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeAccounts
&DBClusterId=cc-xxxxxxxxxx
&<Common request parameters>

Sample success responses

XML format

<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 format

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