Creating a Database Account
Function
This API is used to create a database account for a TaurusDB instance. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
POST /v3/{project_id}/instances/{instance_id}/db-users
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: N/A Range: The value contains 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 with a suffix of in07. Only letters and digits are allowed. Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints: N/A Range: N/A Default value: N/A |
X-Language |
No |
String |
Definition: Request language type. Constraints: N/A Range: Default value: en-us |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
users |
Yes |
Array of CreateDatabaseUserList objects |
Definition: List of database users. Constraints: The list can contain a maximum of 50 database users. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Definition: Database username. Constraints: N/A Range: The username can consist of 1 to 32 characters. Only letters, digits, and underscores (_) are allowed. Default value: N/A |
password |
Yes |
String |
Definition: Database user password. Constraints: The password cannot be empty. You are advised to enter a strong password to improve security and prevent security risks such as brute force cracking. Range: The password can consist of 8 to 32 characters and must contain at least three types of the following: uppercase letters, lowercase letters, digits, and special characters |.~!@#$%^*-_=+?,()& Default value: N/A |
comment |
No |
String |
Definition: Database description. Constraints: This parameter is only available for instances whose kernel version is 2.0.13.0 or later. To upgrade an instance to the latest version, see Upgrading the Kernel Version of a DB Instance. Range: The value can consist of up to 512 characters. It cannot contain carriage returns or any of the following special characters: !<"='>& Default value: N/A |
hosts |
No |
Array of strings |
Definition: List of host IP addresses. Constraints: The list can contain a maximum of 50 IP addresses. Range: % and IP addresses. If the value is 10.10.10.%, all IP addresses in the subnet 10.10.10.X are allowed to access your TaurusDB instance. To specify multiple IP addresses, separate them with commas (,), for example, 192.168.0.1,172.16.213.9 (no spaces before or after the comma). Default value: The default value is %, indicating that all IP addresses are allowed to access your TaurusDB instance. |
databases |
No |
Array of CreateDatabaseList objects |
Definition: List of the databases. When you create a database user, you can grant the permissions of databases in the list to the user. To grant database permissions to a database user, call the API (Granting Permissions to a Database User). Constraints: The list can contain a maximum of 50 databases, or it can be left blank. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Definition: Database name. Constraints: The database must exist. Range: The database name can contain 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. The total number of hyphens (-) cannot exceed 10. Default value: N/A |
readonly |
Yes |
Boolean |
Definition: Whether the permission is read-only. Constraints: N/A Range: Default value: N/A |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Definition: ID of the task for creating a database account. Range: The value is compliant with the UUID format. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Request
Creating a database user with the read/write permission (The host IP address is 127.0.0.1.)
POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users { "users" : [ { "name" : "gaussdb_mysql_user1", "password" : "Rds_1234", "hosts" : [ "127.0.0.1" ], "databases" : [ { "name" : "test", "readonly" : false } ] } ] }
Example Response
Status code: 201
Success.
{ "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d" }
Status Code
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.