Help Center/ Data Admin Service/ API Reference/ APIs (in OBT)/ Intelligent O&M/ Querying Database Users
Updated on 2026-01-20 GMT+08:00
View PDF
Share

Querying Database Users

Function

This API is used to query database users registered on DAS. db_user_id returned by this API is required for calling other APIs (such as the API for querying instance sessions). It does not return database user objects on a DB instance. Currently, only MySQL instances are supported.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    das:clouddba:listDbUser

    list

    Instance

    -

    -

    -

URI

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

Table 1 URI parameters

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 can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Unique ID of an instance

Constraints

N/A

Range

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

Default Value

N/A
Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Index offset. The query starts from the next piece of data indexed by this parameter. If this parameter is set to 1 and limit is set to 10, only the second to eleventh records are displayed.

Constraints

N/A

Range

[0, 2^31-1]

Default Value

0: The query starts from the first data record.

limit

No

Integer

Definition

Number of records to be queried. If this parameter is set to 10, a maximum of 10 records can be displayed.

Constraints

N/A

Range

[1, 100]

Default Value

100

db_user_id

No

String

Definition

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 Creating a Database User.

Constraints

N/A

Range

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

Default Value

N/A

db_username

No

String

Definition

Database username

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Definition

Total number of records

Range

[0, 2^31-1]. The actual value depends on the query result.

db_users

Array of DbUser objects

Definition

Database user list

Range

N/A
Table 4 DbUser

Parameter

Type

Description

db_user_id

String

Definition

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 Creating a Database User.

Range

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

db_username

String

Definition

Database username

Range

N/A

Example Requests

Querying database users

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

Example Responses

Status code: 200

Successful response

{
  "total" : 1,
  "db_users" : [ {
    "db_user_id" : "24c0c455-1f0e-448b-acb2-6e184b4ffcfa",
    "db_username" : "root"
  } ]
}

Status Codes

Status Code

Description

200

Successful response

400

Client error

500

Server error

Error Codes

See Error Codes.

Parent topic: Intelligent O&M