You need to enable JavaScript to run this app.
导航
DescribeAcls
最近更新时间:2024.06.19 17:57:50首次发布时间:2023.10.19 11:11:24

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

使用说明

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

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

kafka-cnoe8qu6hgw1****

待查询 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

访问策略,用于筛选。不支持模糊匹配。

响应参数

参数

参数类型

示例值

说明

Total

Integer

1

符合查询条件的规则总数。

Acls

Array of AclObject

/

当前页的查询结果列表。

示例

请求示例

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-cnoe8qu6hgw1****",
    "PageNumber": 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"
            }
        ]
    }
}