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

CreateUser

最近更新时间：2023.09.12 17:32:18

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

我的收藏

调用 CreateUser 接口创建 Kafka SASL 用户。

使用说明

CreateUser 接口用于在 Kafka 实例下创建一个 SASL 用户，该用户可以使用 SASL/SCRAM 或 SASL/PLAIN 机制发布和订阅消息。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

是

kafka-cnngbnntswg1****

SASL 用户所属的实例 ID。

UserName

String

是

test1

SASL 用户名称。应符合以下要求：

  • 由字母、数字、连字符（-）或下划线组成。
  • 长度为 3~64 个字符。
  • 用户名不支持设置为 admin 或 monitor，且实例内用户名称唯一。

UserPassword

String

是

Test@123456

SASL 用户的密码。应符合以下要求：

  • 长度为 8~32 个字符。
  • 应至少包含大写字母、小写字母、数字、特殊字符中的任意三种。
  • 支持的特殊字符包括!@#$%^&*()_+-=。

AllAuthority

Boolean

是

true

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

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

PasswordType

String

否

Plain

用户密码类型，即 SASL 用户的类型，支持设置为：

  • Scram：SCRAM 类型的 SASL 用户。
  • Plain：PLAIN 类型的 SASL 用户。

说明

如果创建 PLAIN 类型用户，则延迟 1 分钟生效。创建后请耐心等待。

Description

String

否

describe

SASL 用户描述信息。

响应参数

无

示例

请求示例

POST /?Action=CreatCreateUserePublicAddress&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-cnngbnntswg1****",
  "UserName": "user1123123123",
  "UserPassword": "Test@123456",
  "AllAuthority":true,
  "Description": "vip"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230227211906E9F948120F87D27F1AEE",
        "Action": "CreateUser",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": null
}