CreateAclRule

Last updated: 2025-11-11 18:09:18

CreateAclRule

Last updated: 2025-11-11 18:09:18

1. API Description

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

This API shows you how to create an ACL rule.

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: CreateAclRule.
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.
ResourceType	Yes	String	ACL resource type. Currently, the only valid value is `Topic`.
PatternType	Yes	String	ACL rule-based matching type. currently supports prefix match and PRESET policy. valid values: PREFIXED/PRESET.
RuleName	Yes	String	Rule name
RuleList.N	Yes	Array of AclRuleInfo	ACL rule list
Pattern	No	String	Indicates the prefix for prefix match. this parameter is required when PatternType value is PREFIXED.
IsApplied	No	Integer	Specifies whether to apply the preset ACL rule to newly-added topics. defaults to 0, which means no. a value of 1 means yes.
Comment	No	String	Remarks for ACL rules

3. Output Parameters

Parameter Name	Type	Description
Result	Integer	Unique key of a rule
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 Adding ACL Rules Example

Input Example

POST / HTTP/1.1
Host: ckafka.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAclRule
<Common request parameters>

{
    "InstanceId": "ckafka-12345678",
    "ResourceType": "Topic",
    "RuleList": [
        {
            "Host": "1.2.3.4",
            "Principal": "User:*",
            "Operation": "Write",
            "PermissionType": "Allow"
        }
    ],
    "RuleName": "testRule",
    "PatternType": "PREFIXED",
    "Pattern": "testPattern"
}

Output Example

{
    "Response": {
        "Result": 12,
        "RequestId": "8c3daa3a-d87b-47ef-9ccd-f0905eeb8d84"
    }
}

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

Tencent Cloud CLI 3.0

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	Invalid parameter value.
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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud