CreateAccount

更新时间:
复制 MD 格式

Creates a database account for a cluster.

Operation description

For information about the endpoint of this service, see Service registration.

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

adb:CreateAccount

create

*DBClusterLakeVersion

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

None None

Request parameters

Parameter

Type

Required

Description

Example

DBClusterId

string

Yes

The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.

amv-bp11q28kvl688****

AccountName

string

Yes

The name of the database account. The name must meet the following requirements:

  • Starts with a lowercase letter and ends with a lowercase letter or digit.

  • Contains only lowercase letters, digits, or underscores (_).

test_accout

AccountPassword

string

Yes

The password of the database account.

  • Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.

  • Special characters include: !@#$%^&*()_+-=

  • Must be 8 to 32 characters in length.

Test_accout1

AccountDescription

string

No

The description of the account.

  • Cannot start with http:// or https://.

  • Cannot exceed 256 characters in length.

Database connection test account

AccountType

string

Yes

The type of the account. Valid values:

  • Normal: standard account.

  • Super: privileged account.

Normal

Engine

string

No

The database engine. Valid values:

  • AnalyticDB (default): AnalyticDB for MySQL engine.

  • Clickhouse: wide table engine.

Clickhouse

RamUserList

array

No

The list of Alibaba Cloud Resource Access Management (RAM) user IDs to attach. Currently, only one RAM user can be attached.

string

No

The ID of the Alibaba Cloud Resource Access Management (RAM) user to attach.

20732900249392****

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

2FED790E-FB61-4721-8C1C-07C627FA5A19

Examples

Success response

JSON format

{
  "RequestId": "2FED790E-FB61-4721-8C1C-07C627FA5A19"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidAccountName.Malformed The specified parameter AccountName is not valid. The AccountName parameter is invalid. Check the parameter.
400 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.
400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. The DBClusterId parameter is invalid. Check the parameter.
400 InvalidAccountPassword.Malformed The specified parameter AccountPassword is not valid. The AccountPassword parameter is invalid. Check the parameter.
400 InvalidAccountDescription.Malformed The specified parameter AccountDescription is not valid. The AccountDescription parameter is invalid. Check the parameter.
400 InvalidAccountType.Malformed The specified parameter AccountType is not valid. The AccountType parameter is invalid. Check the parameter.
400 ACS.Sql.CannotConnect Cannot connect instance which type is %s. Cannot connect to a child instance of the given type.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.