Updated on 2025-07-11 GMT+08:00

Querying Database Users

Function

This API is used to query database users of a TaurusDB instance. Before calling this API:

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 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

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.

Constraints:

The value cannot be a negative number.

Range:

≥0

Default value:

0

limit

No

Integer

Definition:

Number of records to be queried.

Constraints:

The value cannot be a negative number.

Range:

1–100

Default value:

100

Request Parameters

Table 3 Request header 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:

  • en-us

  • zh-cn

Default value:

en-us

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

users

Array of ListGaussMySqlDatabaseUser objects

Definition:

List of database users.

total_count

Integer

Definition:

Total number of database users of an instance.

Range:

N/A

Table 5 ListGaussMySqlDatabaseUser

Parameter

Type

Description

name

String

Definition:

Database username.

Range:

The username can consist of 1 to 32 characters. Only letters, digits, and underscores (_) are allowed.

host

String

Definition:

Host IP address.

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).

comment

String

Definition:

Database user description.

Range:

The value can consist of up to 512 characters. It cannot contain carriage returns or any of the following special characters: !<"='>&

databases

Array of ListGaussMySqlDatabase objects

Definition:

Database list.

Table 6 ListGaussMySqlDatabase

Parameter

Type

Description

name

String

Definition:

Database name.

Range:

N/A

readonly

Boolean

Definition:

Whether the permission is read-only.

Range:

  • true: read-only

  • false: read/write

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying database users

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users?offset=0&limit=100

Example Response

Status code: 200

Success.

{
  "users" : [ {
    "name" : "gaussdb_mysql_user1",
    "host" : "127.0.0.1",
    "databases" : [ {
      "name" : "test",
      "readonly" : false
    } ]
  } ],
  "total_count" : 1
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.