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

查询用户列表

功能介绍

查询用户列表（仅AMQP版本支持）。

调用方法

请参见如何调用API。

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，默认从0开始查询。

limit

否

String

分页查询单页数量，取值范围0~50，默认查询10条。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

users

Array of AMQPUser objects

用户列表。

total

Integer

总用户个数。
表4 AMQPUser

参数

参数类型

描述

access_key

String

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

secret_key

String

密钥。

8-32个字符。

至少包含以下字符中的3种：

  • 大写字母

  • 小写字母

  • 数字

  • 特殊字符`~!@#$%^&*()-_=+\|[{}];:'",<.>/?。

    不能与名称或倒序的名称相同。

vhosts

Array of AMQPUserPerm objects

需要配置权限的Vhost，一个用户可以配置多个Vhost下的资源权限。
表5 AMQPUserPerm

参数

参数类型

描述

vhost

String

需要配置权限的Vhost名称，一个用户可以配置多个Vhost下的资源权限。

conf

String

使用正则表达式匹配资源配置权限。例如，在输入框内输入“^janeway-.*”，则表示授权给该用户当前Vhost下，所有名称以“janeway-”开头的资源的配置权限。

write

String

使用正则表达式匹配资源写权限。例如，在输入框内输入“.*”，则表示授权给该用户当前Vhost下，所有资源的写权限。

read

String

使用正则表达式匹配资源读权限。例如，在输入框内输入“.*”，则表示授权给该用户当前Vhost下，所有资源的读权限。

请求示例

查询用户列表。

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

响应示例

状态码： 200

查询用户列表成功。

{
  "users" : [ {
    "access_key" : "admin123",
    "secret_key" : "**************",
    "vhosts" : [ {
      "vhost" : "default",
      "conf" : ".*",
      "write" : ".*",
      "read" : ".*"
    } ]
  } ],
  "total" : 1
}

状态码

状态码

描述

200

查询用户列表成功。

错误码

请参见错误码。

父主题： 用户管理

相关文档