Creates a Simple Authentication and Security Layer (SASL) user.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateSaslUser

The operation that you want to perform. Set the value to

CreateSaslUser.

InstanceId String Yes alikafka_pre-cn-v0h1cng0****

The ID of the Message Queue for Apache Kafka instance in which you want to create the SASL user.

Password String Yes 12***

The password of the SASL user.

RegionId String Yes cn-hangzhou

The ID of the region where the instance is located.

Username String Yes test***

The name of the SASL user.

Type String No plain

The authentication mechanism. Valid values:

  • plain: a simple username and password verification mechanism. Message Queue for Apache Kafka provides an improved PLAIN mechanism that allows you to dynamically add SASL users without restarting the instance.
  • SCRAM: a username and password verification mechanism with higher security than PLAIN. Message Queue for Apache Kafka uses SCRAM-SHA-256.

Default value: plain.

Response parameters

Parameter Type Example Description
Code Integer 200

The response code. The HTTP 200 code indicates that the request was successful.

Message String operation success.

The response message.

RequestId String C5CA600C-7D5A-45B5-B6DB-44FAC2C****

The ID of the request.

Success Boolean true

Indicates whether the request was successful.

Examples

Sample requests

http(s)://[Endpoint]/? Action=CreateSaslUser
&InstanceId=alikafka_pre-cn-v0h1cng0****
&Password=12***
&RegionId=cn-hangzhou
&Username=test***
&<Common request parameters>

Sample success responses

XML format

<CreateSaslUserResponse>
      <RequestId>C5CA600C-7D5A-45B5-B6DB-44FAC2C****</RequestId>
      <Message>operation success</Message>
      <Code>200</Code>
      <Success>true</Success>
</CreateSaslUserResponse>

JSON format

{
    "RequestId":"C5CA600C-7D5A-45B5-B6DB-44FAC2C****",
    "Message":"operation success.",
    "Code":"200",
    "Success":"true"
}

Error codes

For a list of error codes, visit the API Error Center.