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

CreateAllowList

最近更新时间：2024.03.06 16:49:23

首次发布时间：2023.12.14 21:43:11

我的收藏

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

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

接口说明

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

请求参数

名称

类型

是否必选

示例值

描述

AllowListName

String

是

testlist

白名单名称。

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

AllowListTypeModifyMode

String

是

IPv4

IP 地址类型，当前仅支持设置为 IPv4。

AllowList

String

否

["1270.0.0.1"]

IP 地址列表，表示允许这些 IP 地址访问。

  • 多个 IP 地址请以英文逗号（,）隔开，不可重复。
  • 支持以下两种格式：
    • IP 地址形式，例如：10.23.12.xx。
    • CIDR 形式，例如：10.23.12.x/xx。
  • 当 IP 较多时，建议合并为 IP 段填入，例如 10.23.12.x/24。"
  • 每个实例最多添加 300 个 IP 或 IP 段，即所有 IP 白名单分组内的 IP 或 IP 段总和不能超过 300。

AllowListDesc

String

否

forTest

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

响应参数

无

示例

请求示例

POST https://rocketmq.volcengineapi.com/?Action=CreateAllowList&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/rocketmq/request, SignedHeaders=x-date, Signature=********

{
    "AllowListId": "acl-b27e5f869f4346f3813e9c26594c****",
    "AllowListName": "test",
    "AllowListDesc": "fortest",
    "AllowList": "0.0.0.0/0",
    "AllowListType": "IPv4"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20231214111052CFEFD0B58D6AF0743461",
        "Action": "CreateAllowList",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-beijing"
    },
    "Result": {}
}