All Products
Search
Document Center

ApsaraDB for ClickHouse:DescribeAccounts

Last Updated:Mar 07, 2025

Queries the information about the database accounts of an ApsaraDB for ClickHouse cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
clickhouse:DescribeAccountsget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

cc-bp108z124a8o7****
AccountNamestringNo

The name of the database account.

Note If you do not specify this parameter, the information about all database accounts in the ApsaraDB for ClickHouse cluster is queried by default.
test
PageSizeintegerNo

The number of entries per page. Valid values:

  • 30 (default)
  • 50
  • 100
30
PageNumberintegerNo

The page number. Pages start from 1. Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of entries returned.

1
PageSizeinteger

The number of entries per page.

30
RequestIdstring

The request ID.

F5178C10-1407-4987-9133-DE4DC9119F75
PageNumberinteger

The page number.

1
Accountsarray<object>

The database accounts.

Accountobject
AccountStatusstring

The state of the database account. Valid values:

  • Creating
  • Available
  • AuthorityModifying
  • Deleting
Note Only XML-configured database accounts can be in the AuthorityModifying state.
Creating
AccountDescriptionstring

The description of the database account.

test
AccountTypestring

The type of the database account. Valid values:

  • Super: privileged account
  • Normal: standard account
Super
AccountNamestring

The name of the database account.

test
ConfigTypestring

The configuration mode of the database account.

SQL

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber": 1,
  "Accounts": {
    "Account": [
      {
        "AccountStatus": "Creating",
        "AccountDescription": "test",
        "AccountType": "Super",
        "AccountName": "test",
        "ConfigType": "SQL"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The DBClusterId provided does not exist in our records.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-11-25API Description Update. The Error code has changed. The response structure of the API has changedView Change Details