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

DescribeAllowLists

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

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

我的收藏

调用 DescribeAllowLists 查询白名单列表。

使用说明

可以使用此接口查看所有的白名单列表。

请求参数

参数

参数类型

是否必选

示例值

说明

RegionId

String

是

cn-beijing

地域 ID。表示查询指定实例下的白名单列表。

InstanceId

String

否

kafka-cnitzqgnk0g4****

Kafka 实例 ID。若指定此参数，表示查询所有绑定此实例 ID 的白名单列表。否则，将返回所有的白名单列表。

响应参数

参数

参数类型

示例值

说明

AllowLists

Array of AllowListInfo

/

白名单列表信息。

示例

请求示例

POST /?Action=DescribeAllowLists&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=********

{
    "RegionId": "cn-beijing",
    "InstanceId": "kafka-cnitzqgnk0g4****"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20231009164722454D149CF757A9BFA1DC",
        "Action": "DescribeAllowLists",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": {
        "AllowLists": [
            {
                "AllowListDesc": "测试",
                "AllowListIPNum": 1,
                "AllowListId": "acl-fc849fa39a114c9684d429b93917***",
                "AllowListName": "测试",
                "AssociatedInstanceNum": 2,
            }
        ]
    }
}