搜索本产品文档关键词
查看用户列表
所有文档
menu

云数据库 DocDB for MongoDB

查看用户列表

查询指定MongoDB实例所有的用户信息以及其权限信息。

说明

  • 不含root用户。

请求结构

Plain Text
1GET /v{version}/instance/{instanceId}?listUsers&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称
类型
是否必须
参数位置
描述
version String URL参数 API版本号
instanceId String URL参数 指定实例Id
marker String Query参数 批量获取列表的查询的起始位置
maxKeys int Query参数 每页包含的最大数量,最大数量通常不超过1000,缺省值为10

返回头域

除公共头域,无其它特殊头域。

返回参数

参数名称
类型
描述
marker String 批量获取列表的查询的起始位置。
maxKeys int 每页包含的最大数量。
isTruncated boolean true表示后面还有数据,false表示已经是最后一页
nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现
result List User 用户数据库列表。

User

参数名称
类型
描述
name String 用户名称
description String 用户备注信息
roles List RoleInfo 用户权限列表

RoleInfo

参数名称
类型
描述
dbName String 数据库名称
role String 此用户在该数据库的权限。取值范围:[read,readWrite]

请求示例

Plain Text
1GET /v1/instance/m-qNlWTz?listUsers&maxKeys=2&marker=user3 HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string

返回示例

Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4Content-Length: 0
5{
6    "result": [
7        {
8            "name": "user3", 
9            "description": "user_description3", 
10            "roles": [
11                {
12                    "dbName": "db1", 
13                    "role": "read"
14                }
15            ]
16        }
17    ], 
18    "marker": "user3", 
19    "isTruncated": false, 
20    "nextMarker": null, 
21    "maxKeys": 2
22}
上一篇
按时间点恢复相关接口
下一篇
更新用户权限