Creating a Database Role

Function

This API is used to create a database role 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 a database role at a time.

URI

POST /v3.1/{project_id}/instances/{instance_id}/db-role

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	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	String	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 role name. Constraints The name cannot be the same as an existing role name, contain special characters, start with pg or a digit, or be the same as a system user or role name. System users or roles include rdsAdmin, rdsMetric, rdsBackup, rdsRepl, and root. Range A database role name can contain 1 to 63 characters, including letters, digits, and underscores (_). Default Value N/A
password	Yes	String	Definition Database role password. 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

Response Parameters

None

Example Request

Creating a database role named dbs

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