You can call the CreateAccount operation to create an account that is used to manage databases on an ApsaraDB RDS instance.

Before you call this operation, make sure that the following requirements are met:

  • The instance must be in the Running state.
  • The databases must be in the Running state.
  • The number of accounts that are created on the instance cannot exceed the maximum number of accounts that are allowed for each instance.
Note
  • This operation is supported only for instances that run MySQL, MariaDB TX, PostgreSQL, or SQL Server. This operation is not supported for instances that run SQL Server 2017 EE or SQL Server 2019 EE.
  • You can create multiple privileged accounts and multiple standard accounts for each RDS instance that runs PostgreSQL with standard SSDs or enhanced SSDs (ESSDs).
  • You can create only one privileged account for each RDS instance that runs PostgreSQL 9.4 or PostgreSQL 10.0 with local SSDs.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateAccount

The operation that you want to perform. Set the value to CreateAccount.

AccountName String Yes test1

The username of the account.

Note
  • The username must be unique.
  • The username must start with a letter and end with a letter or a digit.
  • The username can contain lowercase letters, digits, and underscores (_).
  • The length of the username must meet the following requirements:
    • If the instance runs MySQL 5.6, the username must be 2 to 16 characters in length. If the instance runs MySQL 5.7 or MySQL 8.0, the username must be 2 to 32 characters in length.
    • If the instance runs SQL Server, the username must be 2 to 64 characters in length.
    • If the instance runs PostgreSQL with standard SSDs or ESSDs, the username must be 2 to 63 characters in length. If the instance runs PostgreSQL with local SSDs, the username must be 2 to 16 characters in length.
    • If the instance runs MariaDB TX, the username must be 2 to 16 characters in length.
  • For more information about invalid characters, see Forbidden keywords table.
AccountPassword String Yes Test123456

The password of the account.

Note
  • The password must be 8 to 32 characters in length.
  • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
  • The password can contain the following special characters: !@#$%^&*()_+-=
DBInstanceId String Yes rm-uf6wjk5xxxxxxx

The ID of the instance. You can call the DescribeDBInstances operation to query the IDs of instances.

AccountDescription String No Test Account A

The description of the account. The description must be 2 to 256 characters in length. The description can contain letters, digits, underscores (_), and hyphens (-). The description must start with a letter.

Note The description cannot start with http:// or https://.
AccountType String No Normal

The type of the account. Valid values:

  • Normal: standard account
  • Super: privileged account

Default value: Normal.

Response parameters

Parameter Type Example Description
RequestId String D4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD

The ID of the request.

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=CreateAccount
&DBInstanceId=rm-uf6wjk5xxxxxxx
&AccountName=test1
&AccountPassword=Test123456
&<Common request parameters>

Sample success responses

XML format 

<CreateAccountResponse>
         <RequestId>D4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD</RequestId>
</CreateAccountResponse>

JSON format 

{
    "RequestId":"D4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD"
}

Error codes

For a list of error codes, visit the API Error Center.