DescribeAccounts - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Describes the database accounts of a specified ApsaraDB for ClickHouse cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

clickhouse:DescribeAccounts

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	cc-bp108z124a8o7****
AccountName	string	No	The name of the database account. Note If this parameter is not specified, the operation queries information about all database accounts.	testAccount
PageSize	integer	No	The number of entries to return on each page. Valid values: 30 (default) 50 100	30
PageNumber	integer	No	The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	1
PageSize	integer	The number of entries returned per page.	30
RequestId	string	The request ID.	F5178C10-1407-4987-9133-DE4DC9119F75
PageNumber	integer	The page number.	1
Accounts	object
Account	array<object>	The list of database accounts.
	object
AccountStatus	string	The status of the database account. Valid values: Creating: The account is being created. Available: The account is active. AuthorityModifying: The permissions of the account are being modified. Deleting: The account is being deleted. Note Only database accounts that are configured using XML files can be in the AuthorityModifying state.	Creating
AccountDescription	string	The description of the database account.	test
AccountType	string	The type of the database account. Valid values: Super: a privileged account. Normal: a standard account.	Super
AccountName	string	The name of the database account.	test
ConfigType	string	The configuration method of the database account.	SQL

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.