Call CreateAccountAndAuthority to create an account and grant permissions - ApsaraDB for ClickHouse

Creates a database account and grants permissions.

Operation description

This API is available only for cluster versions 21.8 and earlier. For newer versions, use a high-privilege account and SQL statements to modify user permissions.

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

create

*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 most recent region list.	cn-hangzhou
DBClusterId	string	Yes	The cluster ID.	cc-bp1p816075e21****
AccountName	string	Yes	The name of the database account. Must be unique within the cluster. Can contain only lowercase letters, digits, and underscores (_). Must start with a lowercase letter and end with a lowercase letter or a digit. Must be 2 to 64 characters in length.	test
AccountPassword	string	Yes	The password for the database account. Note Must contain characters from at least three of the following types: uppercase letters, lowercase letters, digits, and special characters. The supported special characters are `!@#$%^&*()_+-=`. Must be 8 to 32 characters in length.	123456Aa
AccountDescription	string	No	The description of the database account. Cannot start with `http://` or `https://`. Must be 0 to 256 characters in length.	ceshi
DmlAuthority	string	Yes	Specifies the DML permissions for the database account. Valid values: all: read, write, and settings permissions. readOnly,modify: read and settings permissions.	all
DdlAuthority	boolean	Yes	Specifies whether to grant DDL permissions to the database account. Valid values: true: DDL operations are allowed. false: DDL operations are denied.	true
AllowDatabases	string	Yes	The databases to which the account has permissions. Separate multiple database names with commas (,).	db1
TotalDatabases	string	No	All databases in the cluster. Separate multiple database names with commas (,).	db1,db2
AllowDictionaries	string	Yes	The dictionaries to which the account has permissions. Separate multiple dictionary names with commas (,).	dt1
TotalDictionaries	string	No	All dictionaries in the cluster. Separate multiple dictionary names with commas (,).	dt1,dt2

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	F5178C10-1407-4987-9133-DE4DC9119F75

Examples

Success response

JSON format

{
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75"
}

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.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.
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.