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

CreateAllowList

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

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

我的收藏

调用 CreateAllowList 接口创建一个新的 IP 白名单规则。

使用说明

创建白名单并绑定白名单和 Kafka 实例后，白名单中配置的 IP 地址或地址段才能访问该实例。每个火山引擎账号在每个地域下最多创建 100 个白名单。

请求参数

参数

参数类型

是否必选

示例值

说明

AllowListName

String

是

测试

白名单名称。

  • 长度为 1～128 个字符。
  • 只能包含中文、字母、数字、下划线和连字符（-）。
  • 不能以数字或连字符（-）开头。
  • 白名单名称在当前地域下唯一。

AllowListDesc

String

否

测试白名单

白名单描述。长度不超过 200 个字符。

AllowList

String

是

127.0.0.1,192.168.0.1/24

白名单 IP 列表。

  • 支持指定为 IP 地址或者 IP 网段。
  • 多个 IP 地址或网段之间使用英文逗号（,）分隔。
  • 每个白名单最多可配置 300 个 IP 地址或网段。

响应参数

参数

参数类型

示例值

说明

AllowListId

String

acl-fda2ed6365b94c909e44198fbbf4****

创建的白名单 ID。

示例

请求示例

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

{
    "AllowList":"127.0.0.1,192.168.0.1/24",
    "AllowListName":"测试",
    "AllowListDesc":"测试白名单"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2023100916165107E94074D816B8C1E88A",
        "Action": "CreateAllowList",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": {
        "AllowListId": "acl-fda2ed6365b94c909e44198f****"
    }
}