You need to enable JavaScript to run this app.
导航
消息队列 Kafka版
  • 文档首页
    • /
  • 消息队列 Kafka版

DescribeSaslUsers

最近更新时间：2022.10.18 16:24:25

首次发布时间：2021.08.30 16:20:22

我的收藏

调用 DescribeSaslUsers 接口获取 Kafka 用户列表。

使用说明

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

  • 此接口的 API Version 为 2018-01-01。
  • 此接口的调用频率限制为 20 次/s，超出频率限制会报错 “AccountFlowLimitExceeded”。

请求参数

参数参数类型是否必选示例值说明
InstanceIdString必选kafka-****实例 ID。
PageNumberInteger必选1用户的页码，最小值为 1。
PageSizeInteger必选1单页的个数。
FiledNameString可选UserName查询结果的排序字段，当前只支持 UserName。

SortOrder

String

可选

Asc

排序方式。支持设置为：

  • Asc：升序排列。
  • Desc：降序排列。
SearchString可选my_user通过用户名称筛选，支持模糊匹配。

响应参数

参数参数类型说明
TotalInteger用户总数
UsersList用户列表。详细说明请参考 StandardSaslUserInfo。

示例

请求示例

POST https://kafka.volcengineapi.com/?Action=DescribeSaslUsers&Version=2018-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: kafka.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/kafka/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "kafka-****",
  "PageNumber": 1,
  "PageSize": 1,
  "FiledName": "UserName",
  "SortOrder": "Asc",
  "Search": "my_user"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "****************",
    "Action": "DescribeSaslUsers",
    "Version": "2018-01-01",
    "Service": "kafka",
    "Region": "cn-beijing"
  },
  "Result": {
        "Total": 1,
        "Users": [
            {
                "AllAuthority": true,
                "CreateTime": "2022-04-07T21:12:50+08:00",
                "Description": "",
                "PasswordType": "Plain",
                "UserName": "test"
            }
        ]
    }
}