CreateAcl - 创建ACL策略--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

CreateAcl - 创建ACL策略

最近更新时间：2024.09.26 15:55:18首次发布时间：2023.10.19 11:11:23

调用 CreateAcl 创建ACL策略

使用说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	CreateAcl	要执行的操作，取值：CreateAcl。
Version	String	是	2022-05-01	API的版本，取值：2022-05-01。
InstanceId	String	是	kafka-cnoe8qu**	待创建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	规则的访问策略。资源类型为Topic时，支持指定“Read”或者“Write”。资源类型为Group时，仅支持“Read”。多个规则之间用“,”分隔。例如：“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-cno**",
    "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,
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter is not valid.	参数值无效。
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后重试。