All Products
Search
Document Center

Message Queue for Apache Kafka:CreateAcl

Last Updated:Jan 16, 2023

Creates an access control list (ACL).

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operate access level Resource type conditional keyword Association operation
alikafka:CreateAcl Write
    All resources
    without
without

Request parameters

Parameter Type Required Description Example
RegionId string Yes

The ID of the region.

cn-hangzhou
InstanceId string Yes

The ID of the ApsaraDB RDS instance.

alikafka_pre-cn-v0h1cng0****
Username string Yes

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

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

test***
AclResourceType string Yes

The type of the resources to which you want to attach tags. Valid values:

  • Topic
  • Group
  • Cluster
  • TransactionalId
Group
AclResourceName string Yes

The name or ID of the resource.

  • The value can be the name of a topic, consumer group, or cluster, or the ID of a transaction.
  • You can use an asterisk (*) to represent the names or IDs of all relevant resources.
X****
AclResourcePatternType string Yes

The mode that is used to match resources. Valid values:

  • LITERAL: full-name match
  • PREFIXED: prefix match
LITERAL
AclOperationType string Yes

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

  • Write: data writes.
  • Read: data reads.
  • Describe: reads of transaction IDs.****
  • IdempotentWrite: idempotent data writes to clusters.
Read

Response parameters

Parameter Type Description Example
object
Code integer

The HTTP status code returned. The HTTP status code 200 indicates that the request is successful.

200
Message string

The returned message.

operation success
RequestId string

The ID of the request.

56729737-C428-4E1B-AC68-7A8C2D5****
Success boolean

Indicates whether the request is successful.

true

Example

Normal return example

JSONFormat

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

Error codes

For a list of error codes, visit the API error center.