ModifyAllowList - 修改访问白名单--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

ModifyAllowList - 修改访问白名单

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

调用 ModifyAllowList 修改一个已经创建的白名单规则。

使用说明

创建白名单规则后，可以使用此接口对白名单名称、描述和规则进行修改。白名单规则的修改将会使用覆盖的方式执行，进行规则修改时需要包含所有的白名单规则。白名单规则的修改将会同步应用到所有已经绑定白名单的实例。

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ModifyAllowList	要执行的操作，取值：ModifyAllowList。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
AllowListId	String	是	"list01"	待修改的白名单 ID。
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。
AllowListName	String	是	testlist	白名单名称。长度为 1～128 个字符。只能包含中文、字母、数字、下划线和连字符（-）。不能以数字或连字符（-）开头。白名单名称在当前地域下唯一。
AllowListDesc	String	否	forTest	修改后的白名单描述。长度不超过 200 个字符。默认值为空，若修改时不设置，则描述会被设置为空字符串。
ModifyMode	String	否	Cover	白名单修改方式，默认值为 Cover。支持设置为： Cover：使用AllowList参数的值覆盖原白名单。 Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。 Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
ApplyDBInstanceNum	Integer	是	1	已应用实例数量，即当前该白名单所绑定的实例数。主要目的是确认本次修改的影响范围，避免误操作引发故障。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://rocketmq.volcengineapi.com/?Action=ModifyAllowList&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",
    "ApplyDBInstanceNum": 0
}

返回示例

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

错误码

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