Help Center/ Data Admin Service/ API Reference/ APIs (in OBT)/ Cloud DBA/ Registering a Database User
Updated on 2024-08-05 GMT+08:00
View PDF
Share

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, this function is supported only for MySQL instances.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

X-Language

No

String

Language.

The value can be:

  • zh-cn
  • en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

db_username

Yes

String

Database username.

db_user_password

Yes

String

Database user password.

datastore_type

Yes

String

Database type. The value is MySQL.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

db_user_id

String

Database user ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum length: 8

Maximum length: 36

error_msg

String

Error message.

Minimum length: 2

Maximum length: 512

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum length: 8

Maximum length: 36

error_msg

String

Error message.

Minimum length: 2

Maximum length: 512

Example Requests

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 Responses

Status code: 200

Success

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

Status Code

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.

Parent topic: Cloud DBA