tencent cloud

DescribeAclRule
最后更新时间：2025-11-21 20:32:48
DescribeAclRule
最后更新时间： 2025-11-21 20:32:48

1. API Description

Domain name for API request: ckafka.intl.tencentcloudapi.com.

This API is used to query the ACL rule list.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeAclRule.
Version Yes String Common Params. The value used for this API: 2019-08-19.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String The ckafka cluster instance Id, which can be obtained through the DescribeInstances api.
RuleName No String ACL rule name
PatternType No String ACL rule-based matching type (PREFIXED: prefix match, PRESET: PRESET policy).
IsSimplified No Boolean Specifies whether to read the simplified ACL rule. default value is false, which means not to read the simplified ACL rule.

3. Output Parameters

Parameter Name Type Description
Result AclRuleResp The set of returned ACL rules
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Enumerating ACL

Input Example

https://ckafka.intl.tencentcloudapi.com/?Action=DescribeAclRule
&InstanceId=ckafka-test
&RuleName=deny-all
&PatternType=PREFIXED
&IsSimplified=false
&<Common request parameters>

Output Example

{
    "Response": {
        "Result": {
            "TotalCount": 1,
            "AclRuleList": [
                {
                    "RuleName": "deny-all",
                    "InstanceId": "ckafka-abc",
                    "PatternType": "PRESET",
                    "Pattern": "topic123",
                    "ResourceType": "Topic",
                    "AclList": "[{\"host\":\"*\",\"operation\":\"Read\",\"permissionType\":\"Allow\",\"principal\":\"User:*\"}]",
                    "CreateTimeStamp": "Thu Jun 06 13:07:13 CST 2024",
                    "IsApplied": 0,
                    "UpdateTimeStamp": "Thu Jun 06 13:07:13 CST 2024",
                    "Comment": "",
                    "TopicName": "",
                    "TopicCount": 0,
                    "PatternTypeTitle": "Preset Policy"
                }
            ]
        },
        "RequestId": "62d589e0-53d5-47e0-95ff-237c48b8fb77"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue.InstanceNotExist The instance does not exist.
InvalidParameterValue.RepetitionValue The parameter already exists.
InvalidParameterValue.SubnetIdInvalid Invalid subnet ID.
InvalidParameterValue.SubnetNotBelongToZone The subnet is not in the zone.
InvalidParameterValue.VpcIdInvalid Invalid VPC ID.
InvalidParameterValue.WrongAction The value of the Action parameter is incorrect.
InvalidParameterValue.ZoneNotSupport The zone is not supported.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation Unauthorized operation.
UnsupportedOperation.BatchDelInstanceLimit The batch instance deletion limit is reached.
UnsupportedOperation.OssReject Oss rejected the operation.
本页内容是否解决了您的问题？
您也可以 联系销售 或 提交工单 以寻求帮助。
是
否

文档反馈