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

DescribeUsers

最近更新时间：2023.11.03 16:04:56

首次发布时间：2023.03.30 19:59:27

我的收藏

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

使用说明

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

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

是

kafka-cnngbnntswg1****

实例 ID。

PageNumber

Integer

是

1

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

PageSize

Integer

是

10

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

UserName

String

否

Name

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

响应参数

参数

参数类型

示例值

说明

Total

Integer

2

SASL 用户总数。

UsersInfo

Array of BasicUserInfoObject

/

SASL 用户列表。详细信息请参考 BasicUserInfoObject。

示例

请求示例

POST /?Action=DescribeUsers&Version=2022-05-01 HTTP/1.1
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-cnng1si21igu****",
  "PageNumber": 1,
  "PageSize": 2,
  "UserName": "test"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230227210916F1649DF74C41E16CB1CA",
        "Action": "DescribeUsers",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": {
        "Total": 2,
        "UsersInfo": [
            {
                "AllAuthority": true,
                "CreateTime": "2022-07-18T07:48:58Z",
                "Description": "",
                "PasswordType": "Plain",
                "UserName": "test"
            },
            {
                "AllAuthority": true,
                "CreateTime": "2022-07-18T07:48:58Z",
                "Description": "test-PHP-sdk",
                "PasswordType": "Scram",
                "UserName": "test-php-sdk"
            }
        ]
    }
}