Creating a Database Account

Function

This API is used to create a database account for a specified instance. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Constraints

This operation cannot be performed when the instance is in any of the following statuses: creating, changing instance specifications, frozen, or abnormal.
This API can only be used to create an account at a time.

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-user

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Explanation: Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Restrictions: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None
instance_id	Yes	Instance ID.

Request Parameters

**Table 2** Parameter description
Parameter	Mandatory	Type	Description
name	Yes	String	Name of the database user, which must be unique. 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: rdsAdmin, rdsMetric, rdsBackup, rdsRepl, and root.
password	Yes	String	Password of the database user. The value cannot be empty and contains 8 to 32 characters. It cannot be the same as the name value or the name value in reverse order. The value must contain at least three types of the following: uppercase letters, lowercase letters, digits, and special characters ~!@#%^*-_=+?, Enter a strong password to improve security, preventing security risks such as brute force cracking.
is_login_only	No	boolean	Whether the database account can only be used for login. Value: false or left blank: The database account can only be used for login, database creation, and database account creation. true: The database account can only be used for login.

Response Parameters

None

Example Request

Creating a database account named dbs

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/db-user
{ 
   "name" : "dbs", 
   "password" : "******" 
 }