Updated on 2025-05-19 GMT+08:00

Registering a Database User

Function

This API is used to register the database username and password with the DAS system. A database user ID will be returned in the response and is required for calling other APIs, such as the API used to query instance sessions. The database password is encrypted and used for DAS API calls only. This API does not create database users on the instance. Ensure that the entered username and password are valid. Currently, only MySQL instances are supported.

URI

POST /v3/{project_id}/instances/{instance_id}/db-users

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region

To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

N/A

instance_id

Yes

String

Explanation:

Unique ID of an instance

Constraints:

N/A

Values:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

db_username

Yes

String

Explanation:

Database username

Constraints:

N/A

Values:

N/A

Default value:

N/A

db_user_password

Yes

String

Explanation:

Database user password

Constraints:

N/A

Values:

N/A

Default value:

N/A

datastore_type

Yes

String

Explanation:

Database type. Currently, only MySQL is supported.

Constraints:

N/A

Values:

MySQL instance: MySQL

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

db_user_id

String

Explanation:

Database user ID, that is, ID of a connection established between the database account and the database. A database user ID is created by calling the API in Registering a Database User.

Values:

The value is a UUID containing 36 characters. Only letters, digits, and hyphens (-) are allowed.

Example Request

Registering the root database user

POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/da304cd5bbb944de828759bc7be3d3fein01/db-users

{
  "db_username" : "root",
  "db_user_password" : "password",
  "datastore_type" : "mysql"
}

Example Response

Status code: 200

Successful request

{
  "db_user_id" : "2e407f6b-8c09-494a-a62f-31b01439596f"
}

Status Codes

Status Code

Description

200

Successful request

400

Client error

500

Server error

Error Codes

See Error Codes.