Updated on 2024-08-08 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.

URI

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

Table 1 Path 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.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

name

No

String

Database account name. If this parameter is transferred, information about a specified account is queried. Otherwise, information about all database accounts is returned.

offset

No

Integer

Index offset.

  • The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
  • The value must be a positive integer.

limit

No

Integer

Maximum records to be queried.

  • The value ranges from 1 to 100.
  • 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

User token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

users

Array of objects

All database accounts. For details, see Table 5.

total_count

Integer

Total number of records.

Table 5 DbUserInfo

Parameter

Type

Description

name

String

Account name.

type

String

Account type. The value can be:

  • rwuser, indicating that the account is an administrator account
  • acluser, indicating that the account is a common account

privilege

String

Account permissions. The value can be:

  • ReadOnly, indicating that the account has read-only permissions
  • ReadWrite, indicating that the account has read and write permissions

databases

Array of strings

All databases that the account has access permissions for.

Example Requests

URI example
GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/
/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.