文档中心

消息队列 Kafka版

SASL 用户管理

DescribeUsers - 查看 SASL 用户列表

DescribeUsers - 查看 SASL 用户列表

调用 DescribeUsers 接口获取 Kafka SASL 用户列表。

使用说明

此接口用于查询指定 Kafka 实例下的用户列表，其中包括 Plain 用户和 Scram 用户。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeUsers

要执行的操作，取值：DescribeUsers。

Version string 必选示例值：2022-05-01

API的版本，取值：2022-05-01。

InstanceId string 必选示例值：kafka-cnngbnntswg1****

实例 ID。

PageNumber integer 必选示例值：1

列表的页码，最小值为 1。

PageSize integer 必选示例值：10

列表中每一页的条目数量，取值范围为 1~100。

UserName string 可选示例值：Name

根据用户名称进行筛选。支持模糊匹配。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Total integer 示例值：2

SASL 用户总数。

UsersInfo object[] 示例值：--

SASL 用户详情。

UserName string 示例值：php-sdk

SASL 用户名称。

Description string 示例值：PHP-sdk

SASL 用户描述。

CreateTime string 示例值：2022-07-18T07:48:58Z

SASL 用户创建时间。

PasswordType string 示例值：Scram

SASL 用户类型。目前支持以下类型：

Plain

Scram

说明

用户类型对应不同的SASL认证机制，详细说明请参考查看接入点。

AllAuthority boolean 示例值：true

用户是否默认具备所有 Topic 的读写权限。

true：此用户具备所有Topic的读写权限。

false：此用户不具备所有Topic的读写权限。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter is not valid.	参数值无效。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
404	InvalidUserName.NotFound	The specified user name already exists.	SASL用户不存在。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后重试。

最近更新时间：2025.08.08 17:47:28

这个页面对您有帮助吗？

有用

有用

无用

无用