文档

DescribeSaslUsers - 查询SASL用户

更新时间:

调用DescribeSaslUsers查询SASL用户。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
InstanceIdstring

实例 ID。

alikafka_pre-cn-v0h1cng0****

返回参数

名称类型描述示例值
object
Codeinteger

状态码。返回 200 代表成功。

200
Messagestring

返回信息。

operation success.
RequestIdstring

请求 ID。

9E3B3592-5994-4F65-A61E-E62A77A****
Successboolean

是否成功。

true
SaslUserListobject []

SASL 用户列表。

Typestring

类型。取值:

  • plain: 一种简单的用户名密码校验机制。消息队列 Kafka 版优化了 PLAIN 机制,支持不重启实例的情况下动态增加 SASL 用户。

  • scram:一种用户名密码校验机制,安全性比 PLAIN 更高。消息队列 Kafka 版使用 SCRAM-SHA-256。

  • LDAP:只有当是 Confluent 实例才会显示此用户类型。

默认值为 plain

scram
Passwordstring

密码。

******
Usernamestring

用户名。

test12***
Mechanismstring

加密方式。

说明 该字段仅 V3 系列(Serverless)实例支持。
SCRAM-SHA-256

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "9E3B3592-5994-4F65-A61E-E62A77A****",
  "Success": true,
  "SaslUserList": {
    "SaslUserVO": [
      {
        "Type": "scram",
        "Password": "******",
        "Username": "test12***",
        "Mechanism": "SCRAM-SHA-256"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Acl.AddSasl.ErrorFailed to add a user. Please refer to the document and try again. If in doubt, submit a work order.新增用户失败,请参考文档后重试,如有疑问,请提交工单。
400Acl.Disable.ErrorThe Acl function is disabled. Enable it by referring to the documentation and try again.Acl 功能未开启,请参考文档开启后重试。
400Acl.DuplicatedAuth.ErrorThe authorization has already been granted, please do not repeat the authorization.已经授权过了,请不要重复授权。
400BIZ_ACL_NOT_ENABLED%s. Please check and try again later.未开启ACL功能
400BIZ_CAN_NOT_ENABLE_ACL%s. Please check and try again later.无法开启ACL,请确认ACL开启条件
400BIZ_UPDATE_ACL_FAILED%s. Please check and try again later.修改ACL失败,请稍后再试
400Instance.CaclulateChange.timeExample Failed to obtain the expected change time. Please try again later.实例获取预期变更时间失败,请稍后重试。
400BIZ_SASL_USER_NOT_EXIST%s. Please check and try again later.指定用户不存在
400BIZ_SASL_USER_NUM_EXCEED%s. Please check and try again later.SASL用户数超限
400Acl.DelSasl.ErrorFailed to delete the user. Check the request parameters and try again.删除用户失败, 请检查请求参数后重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-04-02OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈