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

查询用户列表

功能介绍

查询用户列表。

Kafka实例开启SASL功能时，才支持多用户管理的功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

users

Array of ShowInstanceUsersEntity objects

用户列表。
表3 ShowInstanceUsersEntity

参数

参数类型

描述

user_name

String

用户名称。

由英文字符开头，只能由英文字母、数字、中划线、下划线组成，长度为4~64的字符。

user_desc

String

用户描述。

role

String

用户角色。

default_app

Boolean

是否为默认应用。

created_time

Long

创建时间。

请求示例

查询用户列表。

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/users

响应示例

状态码：200

查询成功。

{
  "users" : [ {
    "user_name" : "xxxa",
    "role" : "guest",
    "default_app" : false,
    "created_time" : 1615431764734
  }, {
    "user_name" : "test",
    "role" : "guest",
    "default_app" : false,
    "created_time" : 1615364062463
  }, {
    "user_name" : "ROOT",
    "role" : "guest",
    "default_app" : false,
    "created_time" : 1617194246328
  } ]
}

状态码

状态码

描述

200

查询成功。

错误码

请参见错误码。

父主题： 用户管理