DescribeAccountAuthority - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries the permissions of a database account.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
clickhouse:DescribeAccountAuthority	get	*EnterpriseDBCluster `acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}`	none	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 parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	F5178C10-1407-4987-9133-DE4DC9119F75
Data	object	The returned result.
DBInstanceId	string	The cluster ID.	cc-bp100p4q1g9z3****
Account	string	The name of the database account.	test1
DmlAuthority	integer	Indicates whether the DML permissions are granted to the database account. Valid values: 0: The account has the permissions to read data from the database, write data to the database, and modify the settings of the database. 1: The account only has the permissions to read data from the database. 2: The account only has the permissions to read data from the database and modify the settings of the database.	0
DdlAuthority	boolean	Indicates whether the DDL permissions are granted to the database account. Valid values: true: The account has the permissions to execute DDL statements. false: The account does not have the permissions to execute DDL statements.	true
AllowDatabases	array	The databases on which permissions are granted.
AllowDatabases	string	The database on which permissions are granted.	db1
AllowDictionaries	array	The dictionaries on which permissions are granted.
AllowDictionaries	string	The dictionary on which permissions are granted.	dt1
TotalDatabases	array	All databases.
TotalDatabases	string	The databases.	db1,db2
TotalDictionaries	array	The database.
TotalDictionaries	string	The dictionary of a database. The value is in the db.dict format.	test1.range_key_dict

Examples

Sample success responses

JSONformat

{
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "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.

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

Change history

Change time	Summary of changes	Operation
2024-07-29	The Error code has changed	View Change Details
2024-05-13	The Error code has changed	View Change Details