All Products
Search
Document Center

ApsaraMQ for Kafka:CreateAcl

Last Updated:Mar 15, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • 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 Key: the condition key that is defined by the cloud service.
  • 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.
OperationAccess levelResource typeCondition keyAssociated operation
alikafka:CreateAclWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
InstanceIdstringYes

The instance ID.

alikafka_pre-cn-v0h1cng0****
UsernamestringYes

The username.

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

test***
AclResourceTypestringYes

The resource type. Valid values:

  • Topic
  • Group
  • Cluster
  • TransactionalId: transaction
Group
AclResourceNamestringYes

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****
AclResourcePatternTypestringYes

The matching mode. Valid values:

  • LITERAL: exact match
  • PREFIXED: prefix match
LITERAL
AclOperationTypestringYes

The operation type. Valid values:

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

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

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

200
Messagestring

The message returned.

operation success
RequestIdstring

The ID of the request.

56729737-C428-4E1B-AC68-7A8C2D5****
Successboolean

Indicates whether the request is successful.

true

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-30The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.