tencent cloud

APIs

ModifyAclRule

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-05-12 20:08:43

1. API Description

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

This API is used to modify ACL policy, currently only support whether to apply preset rules to newly-added topics.

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: ModifyAclRule.
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

ckafka cluster instance Id

For reference: DescribeInstances

RuleName Yes String

ACL rule name

IsApplied No Integer

Input when modifying the preset rule, whether to apply to newly-added topics

Enumeration value:

  • 0: Not allowed to apply to newly-added topics
  • 1: Allowed to apply to newly-added topics

Default value: 0

3. Output Parameters

Parameter Name Type Description
Result Integer

Unique representation Key of the 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 Modifying ACL Rules Demo

This example shows you how to modify ACL rules.

Input Example

https://ckafka.intl.tencentcloudapi.com/?Action=ModifyAclRule
&InstanceId=ckafka-test
&RuleName=deny-all
&IsApplied=1
&<Common request parameters>

Output Example

{
    "Response": {
        "Result": 1,
        "RequestId": "72b987c9-8842-47ac-9ad6-fa2bde3e936d"
    }
}

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
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.InstanceNotExist The instance does not exist.
InvalidParameterValue.NotAllowedEmpty The parameter is required.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan