CreateAllowList - 创建访问白名单--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

CreateAllowList - 创建访问白名单

最近更新时间：2024.11.18 10:27:32首次发布时间：2023.12.14 21:43:11

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

使用说明

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

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	CreateAllowList	要执行的操作，取值：CreateAllowList。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
AllowListName	String	是	testlist	白名单名称。长度为 1～128 个字符。只能包含中文、字母、数字、下划线和连字符（-）。不能以数字或连字符（-）开头。白名单名称在当前地域下唯一。
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 个字符。
AllowListType	String	是	IPv4	IP 地址类型，当前仅支持设置为 IPv4。

返回参数

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

参数	类型	示例值	描述
AllowListId	String	acl-90c721ca3f1648e7b9803xxxxxxx	创建成功的白名单ID.

请求示例

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=********

{
    "AllowListName": "test",
    "AllowListDesc": "fortest",
    "AllowList": "0.0.0.0/0",
    "AllowListType": "IPv4"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240918165415250029132182E97EFD",
    "Action": "CreateAllowList",
    "Version": "2023-01-01",
    "Service": "RocketMQ",
    "Region": "cn-beijing"
  },
  "Result": {
    "AllowListId": "acl-90c721ca3f1648e7b9803xxxxxxx"
  }
}

错误码

公共错误码请参见公共错误码文档。