CreateSQLAccount - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Creates a privileged account or a standard account for an ApsaraDB for ClickHouse cluster.

Operation description

Note This operation is applicable only to ApsaraDB for ClickHouse clusters of V20.8 or later that were created after December 1, 2021,

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:
- The required resource types are displayed in bold characters.
- 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:CreateSQLAccount	create	DBCluster acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	cc-bp1p816075e21****
AccountName	string	Yes	The name of the database account. The name must be unique in the cluster. The name can contain lowercase letters, digits, or underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit. The name must be 2 to 64 characters in length.	test
AccountPassword	string	Yes	The password of the database account. The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - = The password must be 8 to 32 characters in length.	Test1234
AccountDescription	string	No	The description of the database account. The description cannot start with http:// or https://. The description can be up to 256 characters in length or be an empty string.
AccountType	string	Yes	The type of the database account. Valid values: Super: privileged account. Normal: standard account.	Super

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	F5178C10-1407-4987-9133-DE4DC9119F76

Examples

Sample success responses

JSONformat

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

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.

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

Change history

Change time	Summary of changes	Operation
2024-09-25	The Error code has changed	View Change Details