Creating a Database User
Description
This API is used to create a database user for a specified instance.
Restrictions
- 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
Name |
Type |
IN |
Mandatory |
Description |
---|---|---|---|---|
X-Auth-Token |
string |
header |
Yes |
User token obtained from IAM. For details, see Authentication. |
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. |
Requests
- Parameter description
Table 2 Parameter description Name
Type
Mandatory
Description
user_name
String
Yes
The database username.
- 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 (.).
- The username cannot be an internal reserved username, such as drsFull or drsIncremental.
user_pwd
String
Yes
The password of the database user.
- The value must be 8 to 32 characters in length and contain uppercase letters (A to Z), lowercase letters (a to z), digits (0 to 9), and special characters, such as ~!@#%^*-_=+?
- Enter a strong password to improve security, preventing security risks such as brute force cracking.
roles
Array of Object
Yes
The role of the database user. For details, see Table 3.
roles restricts the permissions of the account. If an empty array is specified, the account does not have any permission.
db_name
String
No
The database where the new user is located. 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 3 roles field data structure description Name
Type
Mandatory
Description
role_db_name
String
Yes
The name of the database to which the role granted to the new user 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 the role granted to the new user.
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 (.).
Example Request
{ "user_name":"test" , "user_pwd":"******", "roles":[{ "role_db_name":"testDb" , "role_name":"testRole" }], "db_name":"test_db" }
Responses
- Response example
{}
SDK
Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.
Status Code
For more information, see Status Code.
Error Code
For more information, see Error Code.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot