You need to enable JavaScript to run this app.
导航
消息队列 Kafka版
  • 文档首页
    • /
  • 消息队列 Kafka版

CreateAcl

最近更新时间：2023.10.19 11:11:23

首次发布时间：2023.10.19 11:11:23

我的收藏

调用 CreateAcl 接口创建 ACL 策略。

使用说明

此接口用于创建 ACL 策略规则，为用户设置 Topic 或者 Group 的访问权限。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

是

kafka-cnoe8qu6hgw1****

待创建 ACL 的实例 ID。

UserName

String

是

test

规则允许访问的 SASL 用户。支持指定为“*”，表示允许任意用户访问。

Ip

String

是

192.168.0.1/18,127.0.0.1

规则允许访问的 IP 地址或网段。支持指定为“*”，表示允许任意 IP 访问。多个 IP 之间使用“,”分隔。

ResourceType

String

是

Topic

规则绑定的资源类型。支持配置为 Topic 或者 Group。

PatternType

String

是

Literal

规则的匹配方式。

  • Literal：完全匹配方式。ACL 策略仅匹配名称完全一致的资源。此时需要设置资源名称。
  • Prefixed：前缀匹配方式。ACL 策略匹配指定前缀的资源。此时需要设置资源名称前缀。

Resource

String

是

test

绑定的 Topic 或 Group 的资源名称或名称前缀。

  • 资源名称匹配方式（PatternType）为完全匹配（Literal）时，此字段用于指定资源名称，表示指定用户对某个资源具备权限。支持设置为“*”，表示 Topic 或 Group类型的全部资源。
  • 资源名称匹配方式（PatternType）为前缀匹配（Prefixed）时，此字段用于指定用户对哪些名称前缀的资源具备权限。

AccessPolicy

String

是

Read

SASL 用户具备的权限类型。

  • Read：即从 Topic 消费消息或加入消费组、离开消费组、重置消费位点等。
  • Write：即向 Topic 写入消息。
  • Read,Write：同时具备 Read 和 Write 权限。

说明

资源类型（ResourceType）为 Group 时，仅支持设置为 Read 权限，不支持 Write 权限。

响应参数

无

示例

请求示例

POST /?Action=CreateAcl&Version=2022-05-01 HTTP/1.1
Content-Type: application/json
Host: kafka.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/kafka/request, SignedHeaders=x-date, Signature=********

{
    "InstanceId": "kafka-cnoe8qu6hgw1****",
    "UserName": "test",
    "Ip": "192.168.0.1/18",
    "ResourceType": "Topic",
    "PatternType": "Literal",
    "Resource": "test",
    "AccessPolicy": "Read"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20231009164722454D149CF757A9BFA1DC",
        "Action": "CreateAcl",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": null,
}