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

使用说明

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

调试

请求参数

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

返回参数

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

请求示例

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"
            }
        ]
    }
}

错误码

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