Domain name for API request: ckafka.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.
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 | Instance ID |
ResourceType | Yes | String | ACL resource type. Currently, the only valid value is Topic . |
PatternType | Yes | String | Matching type. Valid values: PREFIXED (match by prefix), PRESET (match by preset policy). |
RuleName | Yes | String | Rule name |
RuleList.N | Yes | Array of AclRuleInfo | ACL rule list |
Pattern | No | String | Prefix value for prefix match |
IsApplied | No | Integer | A parameter used to specify whether the preset ACL rule is applied to new topics |
Comment | No | String | Remarks for ACL rules |
Parameter Name | Type | Description |
---|---|---|
Result | Integer | Unique key of a rule |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: ckafka.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"
}
{
"Response": {
"Result": 12,
"RequestId": "8c3daa3a-d87b-47ef-9ccd-f0905eeb8d84"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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?