DescribeAcls - 查询ACL策略--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

DescribeAcls - 查询ACL策略

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

调用 DescribeAcls 接口查询已创建的 ACL 规则策略。

使用说明

此接口用于查询已创建的 ACL 规则策略，并支持按照部分字段内容做模糊搜索。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeAcls	要执行的操作，取值：DescribeAcls。
Version	String	是	2022-05-01	API的版本，取值：2022-05-01。
InstanceId	String	是	kafka-cnoe8q***	待查询ACL的实例ID。
PageNumber	Integer	是	1	待查询的页码。
PageSize	Integer	是	10	单页查询的最大规则条数。
UserName	String	否	test	SASL 用户名，用于筛选包含指定用户的 ACL 规则。支持使用字符串模糊匹配的方式进行过滤。
Ip	String	否	192.168	IP 地址，用于筛选包含指定 IP 地址的 ACL 规则。支持使用字符串模糊匹配的方式进行过滤。
ResourceType	String	否	Topic	资源类型，支持配置为 Topic 或者 Group。表示筛选包含指定资源类型的 ACL 规则。不支持模糊匹配。
PatternType	String	否	Literal	匹配方式，支持配置为 Literal 或者 Prefixed。表示筛选包含指定匹配方式的 ACL 规则。不支持模糊匹配。
Resource	String	否	test	资源名称或名称前缀，用于筛选。支持模糊匹配。
AccessPolicy	String	否	Read	SASL 用户具备的权限类型。 `Read`：即从 Topic 消费消息或加入消费组、离开消费组、重置消费位点等。 `Write`：即向 Topic 写入消息。 `Read,Write`：同时具备 `Read` 和 `Write` 权限。说明资源类型（ResourceType）为 Group 时，仅支持设置为 Read 权限，不支持 Write 权限。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Total	Integer	1	符合查询条件的规则总数。
Acls	Array of Object	--	当前页的查询结果列表。

请求示例

POST /?Action=DescribeAcls&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-cnoe8q**",
    "PageNumer": 1,
    "PageSize": 20,
    "UserName": "test",
    "Ip": "192.168",
    "ResourceType": "Topic",
    "PatternType": "Literal",
    "Resource": "test",
    "AccessPolicy": "Read"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20231009164722454D149CF757A9BFA1DC",
        "Action": "DescribeAcls",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": {
        "Total": 1,
        "Acls": [
            {
                "UserName": "test",
                "Ip": "192.168.0.1/18",
                "ResourceType": "Topic",
                "PatternType": "Literal",
                "Resource": "test",
                "AccessPolicy": "Read"
            }
        ]
    }
}

错误码

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

状态码	错误码	错误信息	说明
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.	内部错误，请稍后重试。