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 https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/db-role

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. For details about how to obtain the value, 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	String	Instance ID.

Request Parameters

**Table 2** Parameter description
Parameter	Mandatory	Type	Description
name	Yes	String	Database role name, which must be unique. The name can contain 1 to 63 characters. Only letters, digits, and underscores (_) are allowed. It cannot start with pg or a digit and must be different from system users or system roles. System users or roles include rdsAdmin, rdsMetric, rdsBackup, rdsRepl, and root.
password	Yes	String	Database role password. The value cannot be left blank and can contain 8 to 32 characters. It consists of at least three types of the following: uppercase letters, lowercase letters, digits, and special characters (~!@#%^-_=+?,). The value cannot be the same as the name* value or the name value in reverse order. Enter a strong password to improve security, preventing security risks such as brute force cracking.

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