添加 ACL 策略

最近更新时间:2024-03-12 01:17:15

我的收藏

1. 接口描述

接口请求域名: ckafka.tencentcloudapi.com 。

添加 ACL 策略

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateAcl。
Version String 公共参数,本接口取值:2019-08-19。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例id信息
示例值:xxx
ResourceType Integer Acl资源类型,(2:TOPIC,3:GROUP,4:CLUSTER)
示例值:2
Operation Integer Acl操作方式,(2:ALL,3:READ,4:WRITE,5:CREATE,6:DELETE,7:ALTER,8:DESCRIBE,9:CLUSTER_ACTION,10:DESCRIBE_CONFIGS,11:ALTER_CONFIGS,12:IDEMPOTENT_WRITE)
示例值:2
PermissionType Integer 权限类型,(2:DENY,3:ALLOW),当前ckakfa支持ALLOW(相当于白名单),其它用于后续兼容开源kafka的acl时使用
示例值:2
ResourceName String 资源名称,和resourceType相关,如当resourceType为TOPIC时,则该字段表示topic名称,当resourceType为GROUP时,该字段表示group名称,当resourceType为CLUSTER时,该字段可为空。
示例值:Topic1
Host String 默认为*,表示任何host都可以访问。支持填写IP或网段,支持“;”分隔。
示例值:1.1.1.1
Principal String 用户列表,默认为User:*,表示任何user都可以访问,当前用户只能是用户列表中包含的用户。传入时需要加 User: 前缀,如用户A则传入User:A。
示例值:User:user1
ResourceNameList String 资源名称列表,Json字符串格式。ResourceName和resourceNameList只能指定其中一个。
示例值:["Topic1","Topic2"]

3. 输出参数

参数名称 类型 描述
Result JgwOperateResponse 返回结果
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 添加 ACL 策略

输入示例

https://ckafka.tencentcloudapi.com/?Action=CreateAcl
&InstanceId=xxx
&ResourceType=2
&ResourceName=test1
&Operation=2
&PermissionType=2
&Host=1.1.1.1
&Principal=User:user1
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "ReturnCode": "0",
            "ReturnMessage": "ok[apply ok]",
            "Data": {
                "FlowId": 0,
                "RouteDTO": {
                    "RouteId": 0
                }
            }
        },
        "RequestId": "b1ce770b-3623-47d3-b31b-538f8941142d"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue.InstanceNotExist 实例不存在。
InvalidParameterValue.RepetitionValue 已存在相同参数。
InvalidParameterValue.SubnetIdInvalid 无效的子网id。
InvalidParameterValue.SubnetNotBelongToZone 子网不属于zone。
InvalidParameterValue.VpcIdInvalid 无效的 Vpc Id。
InvalidParameterValue.WrongAction Action参数取值错误。
InvalidParameterValue.ZoneNotSupport zone不支持。
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnsupportedOperation.BatchDelInstanceLimit 批量删除实例限制。
UnsupportedOperation.OssReject Oss拒绝该操作。