文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 管理数据库和账号/ 获取数据库账号列表和详情
更新时间：2024-02-05 GMT+08:00
查看PDF
分享

获取数据库账号列表和详情

功能介绍

获取Redis数据库账号列表和详情。

接口约束

  • 只支持GeminiDB Redis接口。
  • 实例在创建、变更规格、修改端口、异常状态或冻结状态下不能执行该操作。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。获取方法请参见获取项目ID。

instance_id

是

String

实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

name

否

String

数据库账号名。若传此参数，则查询指定账号的信息，否则返回所有数据库账号信息。

offset

否

Integer

索引位置，偏移量。

  • 从第一条数据偏移offset条数据后开始查询，默认为0。
  • 取值必须为数字，且不能为负数。

limit

否

Integer

查询个数上限值。

  • 取值范围：1~100。
  • 不传该参数时，默认查询前100条信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

users

Array of objects

数据库用户信息列表。详情请参考表5。

total_count

Integer

总记录数。
表5 DbUserInfo

参数

参数类型

描述

name

String

账号名称。

type

String

账号类型。

  • rwuser：管理员用户
  • acluser：普通用户

privilege

String

账号权限。

  • 取值"ReadOnly"：账号为只读权限；
  • 取值"ReadWrite"：账号为读写权限。

databases

Array of strings

账号已授权的数据库名称列表。

请求示例

URI样例 
GET https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/
/v3/375d8d8fad1f43039e23d3b6c0f60a19/redis/instances/9136fd2a9fcd405ea4674276ce36dae8in12/db-users

响应示例

状态码： 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 
}

状态码

请参见状态码。

错误码

请参见错误码。

相关文档