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

**Table 1** Path parameters
Name	Type	IN	Mandatory	Description
project_id	string	path	Yes	Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.
instance_id	string	path	Yes	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.

**Table 2** Request header parameters
Parameter	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	User token

**Table 3** Parameter description
Parameter	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
Parameter	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 (.).

Request example

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

For details, see Status Code.

For details, see Error Code.

Parent topic: Managing Databases and Users

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.