文档首页/ 分布式消息服务RocketMQ版/ API参考（联盟区域）/ API V2（推荐）/ 用户管理/ 查询用户列表
更新时间：2026-04-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询用户列表

功能介绍

查询用户列表。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释：

查询返回用户的个数。

约束限制：

不涉及。

取值范围：

1~50。

默认取值：

10。

offset

否

Integer

参数解释：

偏移量，表示从此偏移量开始查询。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

0。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

users

Array of UserResp objects

参数解释：

用户列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

total

Number

参数解释：

总用户个数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 UserResp

参数

参数类型

描述

access_key

String

参数解释：

用户名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

secret_key

String

参数解释：

密钥。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

white_remote_address

String

参数解释：

IP白名单。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

admin

Boolean

参数解释：

是否为管理员。

约束限制：

不涉及。

取值范围：

  • true：是管理员。

  • false：不是管理员。

默认取值：

不涉及。

default_topic_perm

String

参数解释：

默认的主题权限。

约束限制：

不涉及。

取值范围：

  • PUB：拥有发布权限。

  • SUB：拥有订阅权限。

  • PUB|SUB：拥有发布订阅权限。

  • DENY：无权限。

默认取值：

不涉及。

default_group_perm

String

参数解释：

默认的消费组权限。

约束限制：

不涉及。

取值范围：

  • SUB：拥有订阅权限。

  • DENY：无权限。

默认取值：

不涉及。

topic_perms

Array of topic_perms objects

参数解释：

特殊的主题权限。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

group_perms

Array of group_perms objects

参数解释：

特殊的消费组权限。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表5 topic_perms

参数

参数类型

描述

name

String

参数解释：

主题名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

perm

String

参数解释：

Topic权限。

约束限制：

不涉及。

取值范围：

  • PUB：拥有发布权限。

  • SUB：拥有订阅权限。

  • PUB|SUB：拥有发布订阅权限。

  • DENY：无权限。

默认取值：

不涉及。
表6 group_perms

参数

参数类型

描述

name

String

参数解释：

消费组名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

perm

String

参数解释：

消费组权限。

约束限制：

不涉及。

取值范围：

  • SUB：拥有订阅权限。

  • DENY：无权限。

默认取值：

不涉及。

请求示例

查询用户列表。

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" : "Abcd1234!",
    "topic_perms" : [ ],
    "white_remote_address" : ""
  } ],
  "total" : 1
}

状态码

状态码

描述

200

查询结果。

错误码

请参见错误码。

父主题： 用户管理