文档中心

缓存数据库 Redis 版

白名单管理

SyncAllowList

SyncAllowList

调用 SyncAllowList 接口同步白名单中绑定的安全组的 IP 地址。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

请求参数说明

参数	类型	是否必选	示例值	描述
AllowListId	String	否	acl-cn02zv7944lzokt****	需进行同步的白名单的 ID。
SecurityGroupBindInfos	Array of SecurityGroupBindInfo	否	请参见请求示例。	传入安全组后，系统将检查指定安全组绑定的 IP 是否有变化。
DryRun	Boolean	否	false	是否对白名单的安全组变更进行预览。取值： true：仅预览，不同步。默认值。 false：不预览，直接同步。

SecurityGroupBindInfo

参数	类型	是否必选	示例值	描述
BindMode	String	是	AssociateEcsIp	安全组关联模式。取值范围如下： IngressDirectionIp：入方向 IP，即允许安全组入方向的源地址中 TCP 协议和 ALL 协议涉及的 IP 访问数据库，若源地址中配置为安全组将被忽略。 AssociateEcsIp：关联 ECS IP，即允许安全组内的云服务器访问数据库，当前仅支持主网卡的 IP 信息导入。说明关于安全组关联模式的更多详情，请参见创建白名单。
SecurityGroupId	String	是	sg-rrzrivu0yc5cv0x588n****	需要关联的安全组 ID。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。一个白名单最多支持 300 个 IP 或 IP 段，关联安全组涉及的 IP 或 IP 段超过限制时会关联失败，您可以调整安全组中的 IP 后重新关联。更多详情，请参见约束与限制。

返回参数

返回参数说明

参数	类型	示例值	描述
ChangeObjects	Array of SyncSecurityGroupChangeObject	请参见返回示例。	白名单绑定的安全组的变化信息。请求参数 DryRun 取值为 false 时，该返回参数的值为 null。

SyncSecurityGroupChangeObject

参数	类型	示例值	描述
AddedIpList	Array of String	["192.168.0.100"]	新增的IP集合
BindMode	String	AssociateEcsIp	安全组关联模式。
HasChanged	Boolean	true	该安全组中的 IP 地址是否有变化。取值： true：有。 false：无。
HasDeleted	Boolean	false	该安全组中的 IP 地址是否有移除。取值： true：有。 false：无。
NewIpList	Array of String	["192.168.0.1,192.168.0.100"]	同步安全组后的白名单的 IP 地址列表。
OldIpList	Array of String	["192.168.0.1"]	同步安全组前的白名单的 IP 地址列表。
RemovedIpList	Array of String	[""]	同步安全组过程中移除的 IP 地址列表。
SecurityGroupId	String	sg-rrzrivu0yc5cv0x588n****	安全组 ID。
SecurityGroupName	String	test sg	安全组名称。

示例

请求示例

返回示例

错误码

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

最近更新时间：2026.09.21 14:23:32

这个页面对您有帮助吗？

有用

有用

无用

无用