All Products
Search
Document Center

ApsaraMQ for Kafka:DeleteAcl

Last Updated:Apr 12, 2024

Deletes 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:DeleteAclWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

cn-hangzhou
InstanceIdstringYes

The ID of the instance.

alikafka_pre-cn-v0h1cng0****
UsernamestringYes

The name of the user.

test12****
AclResourceTypestringYes

The resource type. Valid values:

  • Topic: topic
  • Group: consumer group
  • Cluster: cluster
  • TransactionalId: transactional ID
Topic
AclResourceNamestringYes

The name of the resource.

  • The value can be the name of a topic or consumer group.
  • You can use an asterisk (*) to indicate the names of all topics or consumer groups.
demo
AclResourcePatternTypestringYes

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

  • LITERAL: full match
  • PREFIXED: prefix match
LITERAL
AclOperationTypestringYes

The operation allowed by the access control list (ACL). Valid values:

  • Write: data writes
  • Read: data reads
  • Describe: reads of transactional IDs
  • IdempotentWrite: idempotent data writes to clusters
Write
AclOperationTypesstringNo

The operations allowed by the ACL. Separate multiple operations with commas (,).

Valid values:

  • Write: data writes
  • Read: data reads
  • Describe: reads of transactional IDs
  • IdempotentWrite: idempotent data writes to clusters
Note This parameter is available only for ApsaraMQ for Kafka V3 serverless instances.
Write,Read
AclPermissionTypestringNo

The authorization method. Valid values:

  • Deny
  • ALLOW
Note This parameter is available only for ApsaraMQ for Kafka V3 serverless instances.
DENY
HoststringNo

The IP address of the source.

*

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.

B0740227-AA9A-4E14-8E9F-36ED665****
Successboolean

Indicates whether the request is successful.

true

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "operation success",
  "RequestId": "B0740227-AA9A-4E14-8E9F-36ED665****",
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400Acl.AddSasl.ErrorFailed to add a user. Please refer to the document and try again. If in doubt, submit a work order.Failed to add a user. Please refer to the document and try again. If in doubt, submit a work order.
400Acl.Disable.ErrorThe Acl function is disabled. Enable it by referring to the documentation and try again.The Acl function is disabled. Enable it by referring to the documentation and try again.
400Acl.DuplicatedAuth.ErrorThe authorization has already been granted, please do not repeat the authorization.The authorization has already been granted, please do not repeat the authorization.
400BIZ_ACL_NOT_ENABLED%s. Please check and try again later.-
400BIZ_CAN_NOT_ENABLE_ACL%s. Please check and try again later.-
400BIZ_UPDATE_ACL_FAILED%s. Please check and try again later.-
400Instance.CaclulateChange.timeExample Failed to obtain the expected change time. Please try again later.Example Failed to obtain the expected change time. Please try again later.
400MissingParameterThe %s parameter is required.-
400InvalidParameterThe %s parameter is invalid.-
400Instance.StatusNotRunningThe instance is not running and cannot operate this function. Please try again later.The instance is not running and cannot operate this function. Please try again later.
400Acl.DelSasl.ErrorFailed to delete the user. Check the request parameters and try again.Failed to delete the user. Check the request parameters and try again.
404Instance.NotFoundNo instance found for the %s parameter.-

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

Change history

Change timeSummary of changesOperation
2024-04-02The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 400
    Added Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: AclOperationTypes
    Added Input Parameters: AclPermissionType
    Added Input Parameters: Host
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.
2024-01-26The 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.