文档首页/ 分布式消息服务RocketMQ版/ API参考 (巴黎区域)/ API V2（推荐）/ 用户管理/ 查询用户列表
更新时间：2023-08-16 GMT+08:00
查看PDF
分享

查询用户列表

功能介绍

查询用户列表。

URI

GET /v2/{project_id}/instances/{instance_id}/users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

String

偏移量，表示从此偏移量开始查询， offset大于等于0。

limit

否

String

查询数量。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

users

Array of User objects

用户列表。

total

Number

总用户个数。
表4 User

参数

参数类型

描述

access_key

String

用户名，只能英文字母开头，且由英文字母、数字、中划线、下划线组成，长度为7~64个字符。

secret_key

String

密钥。 8-32个字符。 至少包含以下字符中的3种：

  • 大写字母

  • 小写字母

  • 数字

  • 特殊字符`~!@#$%^&*()-_=+\|[{}];:'",<.>/?密钥。 不能与名称或倒序的名称相同。

white_remote_address

String

IP白名单。

admin

Boolean

是否为管理员。

default_topic_perm

String

默认的主题权限。

default_group_perm

String

默认的消费组权限。

topic_perms

Array of topic_perms objects

特殊的主题权限。

group_perms

Array of group_perms objects

特殊的消费组权限。
表5 topic_perms

参数

参数类型

描述

name

String

主题名称。

perm

String

权限。
表6 group_perms

参数

参数类型

描述

name

String

消费组名称。

perm

String

权限。

请求示例

查询用户列表。

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/users?offset=0&limit=10

响应示例

状态码： 200

查询结果。

{
  "users" : [ {
    "access_key" : "test_01",
    "admin" : false,
    "default_group_perm" : "DENY",
    "default_topic_perm" : "SUB",
    "group_perms" : [ ],
    "secret_key" : "**************",
    "topic_perms" : [ ],
    "white_remote_address" : ""
  } ],
  "total" : 1
}

状态码

状态码

描述

200

查询结果。

错误码

请参见错误码。

父主题： 用户管理