Call DescribeAccountAuthority to query database account permissions - ApsaraDB for ClickHouse

Queries the permissions of a database account.

Operation description

This API applies only to clusters of v21.8 or earlier. For clusters running a later version, you must use a privileged account and execute SQL statements to modify the permissions of a regular user.

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:DescribeAccountAuthority

get

*DBCluster

acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. You can call the DescribeRegions operation to query the latest region list.	cn-hangzhou
DBClusterId	string	Yes	The cluster ID.	cc-bp1p816075e21****
AccountName	string	No	The database account name.	test

Response elements

Element	Type	Description	Example
	object
DdlAuthority	boolean	Indicates whether the account has DDL permissions. Valid values: true: DDL permissions are granted. false: DDL permissions are denied.	true
DmlAuthority	string	The DML permission level for the account. Valid values: all: read, write, and settings permissions. readOnly,modify: read and settings permissions.	all
RequestId	string	The request ID.	F5178C10-1407-4987-9133-DE4DC9119F75
TotalDatabases	array	A list of all databases in the cluster.
	string	A comma-separated string of all database names, returned as a single element in an array.	db1,db2
TotalDictionaries	array	A list of all dictionaries in the cluster.
	string	A comma-separated string of all dictionary names, returned as a single element in an array.	dt1,dt2
AllowDictionaries	array	The list of authorized dictionaries.
	string	The name of a dictionary.	dt1
AllowDatabases	array	The list of authorized databases.
	string	The name of a database.	db1
AccountName	string	The database account name.	test

Examples

Success response

JSON format

{
  "DdlAuthority": true,
  "DmlAuthority": "all",
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "TotalDatabases": [
    "db1,db2"
  ],
  "TotalDictionaries": [
    "dt1,dt2"
  ],
  "AllowDictionaries": [
    "dt1"
  ],
  "AllowDatabases": [
    "db1"
  ],
  "AccountName": "test"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.	An error occurred while processing your request.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.