CreateUser - 创建 SASL 用户--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

CreateUser - 创建 SASL 用户

最近更新时间：2024.09.26 15:55:18首次发布时间：2023.03.30 19:59:26

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

使用说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	CreateUser	要执行的操作，取值：CreateUser。
Version	String	是	2022-05-01	API的版本，取值：2022-05-01。
InstanceId	String	是	kafka-cnngbnntswg1****	用户所属的实例 ID。
UserName	String	是	test1	SASL 用户名称。应符合以下要求：由字母、数字、连字符（-）或下划线组成。长度为 3~64 个字符。用户名不支持设置为 admin 或 monitor，且实例内用户名称唯一。
UserPassword	String	是	Test@123456	SASL 用户的密码。应符合以下要求：长度为 8~32 个字符。应至少包含大写字母、小写字母、数字、特殊字符中的任意三种。支持的特殊字符包括`!@#$%^&*()_+-=`。
Description	String	否	describe	SASL 用户描述信息。
AllAuthority	Boolean	是	true	用户是否默认具备所有 Topic 的读写权限。 true：此用户具备所有 Topic 的读写权限。 false：此用户不具备所有 Topic 的读写权限。
PasswordType	String	否	Plain	用户密码类型，即 SASL 用户的类型，支持设置为： Scram：SCRAM 类型的 SASL 用户。 Plain：PLAIN 类型的 SASL 用户。说明如果创建 PLAIN 类型用户，则延迟 1 分钟生效。创建后请耐心等待。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

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
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter is not valid.	参数值无效。
400	InvalidUserName.AlreadyExists	The specified user name already exists.	SASL用户已存在。
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后重试。