Updated on 2025-10-24 GMT+08:00

Creating a Database Role

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

This API applies only to DDS Community Edition.
This operation is not allowed if the DB instance is in any of the following statuses: creating, changing instance class, changing port, frozen, restarting, or abnormal.

URI format
POST /v3/{project_id}/instances/{instance_id}/db-role
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/659914406d2c4c76bce6a028ce8d8e0din02/db-role

**Table 1** Path parameters
Name	Mandatory	Type	IN	Description
project_id	Yes	string	path	Explanation: Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A
instance_id	Yes	string	path	Explanation: Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one. Constraints: N/A Value range: N/A Default value: N/A

**Table 2** Request header parameters
Name	Mandatory	Type	IN	Description
X-Auth-Token	Yes	string	header	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Parameter description
Name	Type	Mandatory	Description
role_name	String	Yes	The name of the role to be created. The value must be 1 to 64 characters and can contain only letters (from A to Z or from a to z), digits (from 0 to 9), hyphens (-), and periods (.).
roles	Array of objects	No	The list of roles inherited by the new role. For details, see Table 4.
db_name	String	No	The name of the database to which the role belongs. The default value is admin. The value must be 1 to 64 characters and can contain only letters (from A to Z or from a to z), digits (from 0 to 9), and underscores (_).

**Table 4** roles field data structure description
Name	Type	Mandatory	Description
role_db_name	String	Yes	The name of the database to which an inherited role belongs. The value must be 1 to 64 characters and can contain only letters (from A to Z or from a to z), digits (from 0 to 9), and underscores (_).
role_name	String	Yes	The name of an inherited role. The value must be 1 to 64 characters and can contain only letters (from A to Z or from a to z), digits (from 0 to 9), hyphens (-), and periods (.).

Creating a database role testRole for a specified instance

{
    "role_name": "testRole",
    "roles" : [{
        "role_name":"readWrite",
        "role_db_name":"testDb" 
    }],
    "db_name":"testDb" 
}

For more information, see Status Code.

For more information, see Error Code.

Parent topic: Managing Databases and Users