Creates an access control list (ACL).

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 CreateAcl

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

CreateAcl.

AclOperationType String Yes Read

The type of operations allowed by the ACL. Valid values:

  • Write
  • Read
AclResourceName String Yes X***

The name of the resource.

  • The value can be the name of a topic or consumer group.
  • You can use an asterisk (*) to represent the names of all topics or consumer groups.
AclResourcePatternType String Yes LITERAL

The matching mode. Valid values:

  • LITERAL: full match
  • PREFIXED: prefix match
AclResourceType String Yes Group

The type of the resource. Valid values:

  • Topic
  • Group
InstanceId String Yes alikafka_pre-cn-v0h1cng00***

The ID of the Message Queue for Apache Kafka instance.

RegionId String Yes cn-hangzhou

The ID of the region where the Message Queue for Apache Kafka instance is located.

Username String Yes test***

The username of the Simple Authentication and Security Layer (SASL) user.

You can use an asterisk (*) to represent all usernames.

Response parameters

Parameter Type Example Description
Code Integer 200

The returned HTTP status code. A 200 status code indicates that the request succeeded.

Message String operation success

The returned message.

RequestId String 56729737-C428-4E1B-AC68-7A8C2D5****

The ID of the request.

Success Boolean true

Indicates whether the request was successful.

Examples

Sample request

http(s)://[Endpoint]/? Action=CreateAcl
&AclOperationType=Read
&AclResourceName=X***
&AclResourcePatternType=LITERAL
&AclResourceType=Group
&InstanceId=alikafka_pre-cn-v0h1cng00***
&RegionId=cn-hangzhou
&Username=test***
&<Common request parameters>

Sample success responses

XML format

<CreateAclResponse>
      <RequestId>56729737-C428-4E1B-AC68-7A8C2D5****</RequestId>
      <Message>operation success</Message>
      <Code>200</Code>
      <Success>true</Success>
</CreateAclResponse>

JSON format

{
    "CreateAclResponse": {
        "RequestId": "56729737-C428-4E1B-AC68-7A8C2D5****",
        "Message": "operation success",
        "Code": 200,
        "Success": true
    }
}

Error codes

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