文档中心

云数据库 MySQL 版

安全加密

ModifyAllowList - 修改白名单

ModifyAllowList - 修改白名单

调用 ModifyAllowList 接口修改白名单。

请求类型

异步请求。

注意事项

该接口支持通过绑定安全组和输入 IP 修改白名单，两种方式可同时进行。在绑定安全组创建的方式下，可使用 SecurityGroupIds 或 SecurityGroupBindInfos 字段，这两个字段不能同时使用；在输入 IP 创建的方式下，可使用 AllowList 或 UserAllowList 字段，这两个字段不能同时使用。

如果通过该接口修改白名单绑定的安全组，只能采用覆盖的修改方式，即请求参数 ModifyMode 取值为 Cover。如果在修改白名单绑定的安全组的同时需要修改白名单的 IP，需要注意覆盖的修改方式对 IP 的影响。

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
AllowListId	String	是	acl-04908986ad034ac0ba1fb1e3a754****	白名单 ID。说明您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单 ID。
AllowListName	String	是	test	白名单名称。说明若需修改原白名单的 IP 地址，直接输入原白名单的名称即可。您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单名称。若需修改白名单名称，直接输入新的白名单名称即可。名称需同时满足如下要求：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需为 1~32 个字符。
ModifyMode	String	否	Cover	修改方式，取值范围如下： Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。 Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。 Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
AllowListDesc	String	否	test	白名单的备注信息，长度不可超过 200 个字符。
AllowList	String	否	192...1	安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明每个白名单中最多支持设置 300 个 IP 地址或 CIDR 格式的 IP 地址段。不允许设置重复的地址，多个地址间用英文逗号（,）隔开。设置 0.0.0.0/0，表示允许所有地址访问。设置 127.0.0.1，表示禁止所有地址访问。同时设置 0.0.0.0/0 和 127.0.0.1，表示允许所有地址访问。设置 CIDR 192.168.1.0/24，表示允许该网段内的 IP 地址访问。设置 192.168.1.1，表示仅允许该 IP 地址访问。该字段与 UserAllowList 不能同时使用。
ApplyInstanceNum	Integer	否	1	当前白名单所绑定的实例个数。说明当需要修改 AllowList 参数或 UserAllowList 参数时，该参数必填。您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单下绑定的实例总数。
SecurityGroupIds	Array of String	否	["sg-13fuw9bo2hlhc3n6nu4g****"]	需要修改的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
SecurityGroupBindInfos	Array of SecurityGroupBindInfo	否	请参见请求示例。	白名单关联的安全组的信息。说明该字段不能与 SecurityGroupIds 同时使用。
AllowListCategory	String	否	Default	白名单分类。取值： Ordinary：普通白名单。 Default：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
UserAllowList	String	否	10...1,10...0/24	安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段与 AllowList 不能同时使用。
UpdateSecurityGroup	Boolean	否	true	是否更新白名单所绑定的安全组。 true：更新。 false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
IgnoreInstanceStatus	Boolean	否	true	是否忽略实例状态校验。取值： true：是。 false：否。默认值。
ProjectName	String	否	default	所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。

SecurityGroupBindInfo

参数	类型	是否必选	示例值	描述
BindMode	String	是	AssociateEcsIp	关联安全组的模式。取值： IngressDirectionIp：入方向 IP。 AssociateEcsIp：关联 ECSIP。说明在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。
SecurityGroupId	String	是	sg-b8pzuwk3i4g028j06k8f****	安全组 ID。说明在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。
IpList	Array of String	否	["10...1/32","10...2/32"]	安全组的 IP。
SecurityGroupName	String	否	测试安全组	安全组名称。说明在 DescribeAllowLists 接口中，SecurityGroupBindInfoObject 作返回参数时不返回该字段。

返回参数

null

示例

请求示例

返回示例

错误码

更多详情，请参见错误码。

最近更新时间：2026.04.09 11:58:29

这个页面对您有帮助吗？

有用

有用

无用

无用