You can call this operation to query the account information of a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeAccounts

The operation that you want to perform. Set the value to

DescribeAccounts.

DBClusterId String Yes rm-uf6wjk5xxxxxxxxxx

The ID of the cluster.

AccountName String No test_accout

The account of the database.

AccountType String No Normal
  • Normal: standard account
  • Super: privileged account

Response parameters

Parameter Type Example Description
AccountList Array of DBAccount

The list of database accounts.

DBAccount
AccountDescription String The account of the test database.

The description of the account.

AccountName String test1

The name of the account.

AccountStatus String Available

The status of the account.

  • Creating: The account is being created.
  • Available: The account is available.
  • Deleting: The account is being deleted.
AccountType String Normal
  • Normal: standard account
  • Super: privileged account
RequestId String 64E37E6F-C363-41F3-867A-70EF5DC60EA4

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

<RequestId>64E37E6F-C363-41F3-867A-70EF5DC60EA4</RequestId>
<AccountList>
    <DBAccount>
        <AccountDescription>Test the database account</AccountDescription>
        <AccountStatus>Available</AccountStatus>
        <AccountType>Normal</AccountType>
        <AccountName>test1</AccountName>
    </DBAccount>
</AccountList>

JSON format

{
    "RequestId":"64E37E6F-C363-41F3-867A-70EF5DC60EA4",
    "AccountList":{
        "DBAccount":[
            {
                 "AccountDescription":"Test the database account",
                 "AccountStatus":"Available",
                 "AccountType":"Normal",
                 "AccountName":"test1"
            }
        ]
    }
}

Error codes

HttpCode Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified DBClusterId parameter does not exist. Check whether you specify the DBClusterId parameter correctly.

For a list of error codes, visit the API Error Center.