DescribeAccountAuthority - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Call the DescribeAccountAuthority operation to query the permissions of an account.

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

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
DBInstanceId	string	Yes	The cluster ID.	cc-bp100p4q1g9z3****
Account	string	Yes	The name of the database account.	test1

Response elements

Element	Type	Description	Example
	object	The details of the response.
RequestId	string	The request ID.	F5178C10-1407-4987-9133-DE4DC911****
Data	object	The returned data.
DBInstanceId	string	The cluster ID.	cc-bp100p4q1g9z3****
Account	string	The name of the database account.	test1
DmlAuthority	integer	The DML permissions that are granted to the database account. Valid values: 0: Read, write, and change settings queries are allowed. 1: Only read data queries are allowed. 2: Read data and change settings queries are allowed.	0
DdlAuthority	boolean	Indicates whether DDL permissions are granted to the database account. Valid values: true: DDL operations are allowed. false: DDL operations are prohibited.	true
AllowDatabases	array	A list of authorized databases.
	string	A list of authorized databases.	db1
AllowDictionaries	array	A list of authorized dictionaries.
	string	A list of authorized dictionaries.	dt1
TotalDatabases	array	A list of all databases.
	string	A list of all databases.	db1,db2
TotalDictionaries	array	The database.
	string	A dictionary in a database. The format is db.dict.	test1.range_key_dict

Examples

Success response

JSON format

{
  "RequestId": "F5178C10-1407-4987-9133-DE4DC911****",
  "Data": {
    "DBInstanceId": "cc-bp100p4q1g9z3****",
    "Account": "test1",
    "DmlAuthority": 0,
    "DdlAuthority": true,
    "AllowDatabases": [
      "db1"
    ],
    "AllowDictionaries": [
      "dt1"
    ],
    "TotalDatabases": [
      "db1,db2"
    ],
    "TotalDictionaries": [
      "test1.range_key_dict"
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.	The passed instance ID does not exist.
404	InvalidAccountName.NotFound	Specified account name does not exist.	The specified account name does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.