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 /v3/{project_id}/instances/{instance_id}/db-user

**Table 1** Parameter description
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 The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Parameter description
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Database username. Constraints The name must be unique. The name cannot contain other special characters, cannot start with pg or a digit, and cannot be the same as that of the system users. System users: rdsAdmin, rdsMetric, rdsBackup, rdsRepl, and root. Range The database username can contain 1 to 63 characters, including letters, digits, and underscores (_). Default Value N/A
password	Yes	String	Definition Password of the database user. A strong password helps improve security and mitigate potential threats like brute force attacks. Constraints It cannot be the same as the name value or the name value spelled backwards. Range It must consist of 8 to 32 characters, including at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters ~!@#%^-_=+?, Default Value* N/A
is_login_only	No	boolean	Definition Whether the database account can only be used for login. Constraints N/A Range 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. Default Value N/A

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" : "******" 
 }