Updated on 2025-09-04 GMT+08:00

Creating a Database Account

This API is used to create a database account for a specified DB instance.

This operation cannot be performed when the DB instance is in any of the following statuses: creating, changing instance class, changing port, or abnormal.
If you want to call this API repeatedly to create database accounts for your DB instance, call it in serial.

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	Definition Instance ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Specifies the username of the database account. Constraints N/A Range The username contains 1 to 63 characters, including letters, digits, and underscores (_). It cannot start with pg or a digit and must be different from system usernames. System users include rdsAdmin, rdsMetric, rdsBackup, rdsRepl, rdsProxy, and rdsDdm. Default Value N/A
password	Yes	String	Definition Specifies the password of the database account. Constraints N/A Range The value must be 8 to 32 characters long and contain at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters (~!@#%^-_=+?,). The value cannot contain the username or the username spelled backwards. You are advised to enter a strong password to improve security, preventing security risks such as brute force cracking. Default Value* N/A

Creating a database account named rds

{
    "name": "rds",
    "password": "****"
}

**Table 3** Parameters
Parameter	Type	Description
resp	String	Definition Calling result. Range Returns successful if the calling is successful.

For details, see Error Codes.