Updated on 2026-09-22 GMT+08:00

Obtaining the Database Account List

Function

This API is used to obtain the GeminiDB Redis database account list.

Constraints

Only the GeminiDB Redis API is supported.
This operation cannot be performed when the instance is in any of the following states: creating, changing specifications, changing database port, frozen, or abnormal.

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 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
gaussdbfornosql:instance:listDatabaseUser	List	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:dbuser:list	-

URI

GET /v3/{project_id}/redis/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. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
name	No	String	Definition Database account name. Constraints If this parameter is transferred, information about a specified account is queried. Otherwise, information about all database accounts is returned. Range N/A Default Value N/A
offset	No	Integer	Definition Index offset. Constraints N/A Range ≥ 0 Default Value The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
limit	No	Integer	Definition Maximum records to be queried. Constraints N/A Range 1–100 Default Value If this parameter is not transferred, the first 100 records are queried by default.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
users	Array of Table 5 objects	Definition Database user information list.
total_count	Integer	Definition Total number of records. Range N/A

**Table 5** DbUserInfo
Parameter	Type	Description
name	String	Definition Account name. Range N/A
type	String	Definition Account type. Range rwuser: administrator acluser: common user
privilege	String	Definition Account permission. Range ReadOnly: The account has the read-only permission. ReadWrite: The account has the read and write permissions.
databases	Array of strings	Definition All databases that the account has access permissions for.

Example Requests

URI example

GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/redis/instances/9136fd2a9fcd405ea4674276ce36dae8in12/db-users

Example Responses

Status code: 200

Success

{ 
  "users" : [ { 
    "name" : "db_user1", 
    "type" : "rwuser", 
    "privilege" : "ReadWrite", 
    "databases" : [ "1", "2" ] 
  }, { 
    "name" : "db_user2", 
    "type" : "acluser", 
    "privilege" : "ReadWrite", 
    "databases" : [ "1", "2" ] 
  } ], 
  "total_count" : 2 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Managing Databases and Accounts