All Products
Search
Document Center

Message Queue for Apache Kafka:DescribeAcls

Last Updated:Nov 18, 2022

Queries access control lists (ACLs).

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the instance.

cn-hangzhou
InstanceIdstringYes

The ID of the instance.

alikafka_pre-cn-v0h1cng****
UsernamestringYes

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

test12****
AclResourceTypestringYes

The type of the resource. Valid values:

  • Topic
  • Group
Topic
AclResourceNamestringYes

The name of the resource.

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

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

  • LITERAL: full-name match
  • PREFIXED: prefix match
LITERAL

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

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

200
Messagestring

The returned message.

operation success.
RequestIdstring

The ID of the request.

46496E38-881E-4719-A2F3-F3DA6AE****
Successboolean

Indicates whether the request is successful.

true
KafkaAclListarray

The ACLs.

object
AclResourceTypestring

The type of the resource. Valid values:

  • Topic
  • Group
Topic
Hoststring

The host.

****
AclOperationTypestring

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

  • Write
  • Read
Write
AclResourceNamestring

The name of the resource.

  • The value can be the name of a topic or a consumer group.
  • An asterisk (*) represents the names of all topics or consumer groups.
demo
AclResourcePatternTypestring

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

  • LITERAL: full-name match
  • PREFIXED: prefix match
LITERAL
Usernamestring

The name of the SASL user.

test12***

Example

Normal return example

JSONFormat

{
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "46496E38-881E-4719-A2F3-F3DA6AE****",
  "Success": true,
  "KafkaAclList": [
    {
      "AclResourceType": "Topic",
      "Host": "****",
      "AclOperationType": "Write",
      "AclResourceName": "demo",
      "AclResourcePatternType": "LITERAL",
      "Username": "test12***"
    }
  ]
}

Error codes

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