文档中心

消息队列 RocketMQ版

白名单管理

ModifyAllowList - 修改访问白名单

调用 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 可选示例值：127.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 /?Action=ModifyAllowList&Version=2023-01-01 HTTP/1.1​
Host:  rocketmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260115T070447Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260115/cn-beijing/RocketMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "AllowListId": "list01",​
  "AllowListName": "testlist",​
  "ApplyDBInstanceNum": 1​
}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "2026011515045122704609708010****",​
    "Action": "ModifyAllowList",​
    "Version": "2023-01-01",​
    "Service": "RocketMQ",​
    "Region": "cn-beijing"​
  },​
  "Result": {}​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter	The request body is missing a required parameter %s.	缺少%s参数。
400	InvalidParameter	The specified parameter %s is not valid.	参数值%s无效，请检查后重试。
400	InvalidPara	The specified parameter is not valid.	参数值无效。
400	UnsupportedParameter	The specified parameter %s is unsupported.	不支持%s参数。
400	OperationDenied.InvalidRequest	The request that you specified is not valid.	请求异常，请检查后重试。
403	OperationDenied_AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
403	OperationDenied.VersionUnsupported	The current instance version does not support this operation.Please upgrade the instance and try again.	当前实例版本不支持指定操作，请升级实例后再试。
403	OperationDenied.TaskIsRunning	An operation is currently in progress. Try again later.	后台任务正在运行中，请稍后再试。
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
403	OperationDenied.ResourceOccupied	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后再试。
500	ServerInternalError	The request failed due to some unknown error, exception or failure.	服务内部错误。
500	ResourceIsBusy	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
503	ServiceUnavailable	The request failed due to a temporary failure of the server.	当前服务暂时不可用。

最近更新时间：2026.02.13 18:31:53

这个页面对您有帮助吗？

有用

无用