Querying Database Users

Function

This API is used to query database users of a GaussDB(for MySQL) instance. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID, which is compliant with the UUID format.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.
limit	No	Integer	Number of records to be queried. The default value is 100. The value must be a positive integer. The minimum value is 1 and the maximum value is 100.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the token value.
X-Language	No	String	Request language type. The default value is en-us. Values: en-us zh-cn

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
users	Array of ListGaussMySqlDatabaseUser objects	List of database users.
total_count	Integer	Total number of database users of a DB instance.

**Table 5** ListGaussMySqlDatabaseUser
Parameter	Type	Description
name	String	Database username.
host	String	Host IP address.
comment	String	Remarks of the database account.
databases	Array of ListGaussMySqlDatabase objects	List of databases.

**Table 6** ListGaussMySqlDatabase
Parameter	Type	Description
name	String	Database name.
readonly	Boolean	Whether the permission is read-only. 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",
    "comment" : "database_user_comment", 
    "databases" : [ {
      "name" : "test",
      "readonly" : false
    } ]
  } ],
  "total_count" : 1
}