调用 ModifyAllowList 接口修改目标白名单信息（例如白名单名称、IP 地址、是否设置为默认白名单等）。 ## 请求类型异步请求。 ## 注意事项 * 在缓存数据库 Redis 版中使用白名单时存在一些约束和限制，具体限制请参见[创建白名单](https://docs.volcengine.com/docs/6293/70856#.5rOo5oSP5LqL6aG5)。 * 出于数据安全考虑，不允许在开启实例免密访问功能的同时，将地址 `0.0.0.0/0` 加入实例的白名单中。如需在白名单中设置地址 `0.0.0.0/0`，请先关闭实例的免密访问功能。免密访问功能设置方法，请参见 [ModifyDBInstanceVpcAuthMode](https://docs.volcengine.com/docs/6293/99795)。 ## 调试 [去调试](https://api.volcengine.com/api-explorer/debug?action=ModifyAllowList&serviceCode=Redis&version=2020-12-07&groupName=白名单管理) ## 请求参数 |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |AllowListId |String |是 |acl\-cnlf3xgczbjldzy\*\*\*\* |白名单 ID。

说明

您可以调用 DescribeAllowLists接口查询指定地域下所有的白名单列表信息，包括白名单 ID。

说明

若不设置该参数，默认使用白名单的原名称。

若需修改白名单名称，直接输入新的白名单名称即可。名称需同时满足如下要求：

不能以数字、中划线（\-）开头。

只能包含中文、字母、数字、下划线（_）和中划线（\-）。

长度需为 1~128 个字符。

说明

若不设置该参数，表示不修改白名单的备注信息。

若传入空字符串（即 "AllowListDesc":""），表示清空白名单的备注信息。

说明

仅当需要变更白名单中的 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 地址访问。

说明

当需要修改白名单的 IP（即 AllowList）或关联安全组（即 SecurityGroupBindInfos）信息时，该参数必填。

该参数传入的值必须与当前白名单所绑定的实例个数一致，否则调用该接口时会报错。

您可以调用 DescribeAllowLists 接口查询当前账号下在指定地域内的所有白名单列表信息，包括白名单下绑定的实例总数（即返回参数中 AssociatedInstanceNum的参数值）。

说明

每个火山引擎账号在每个地域最多可设定一个默认白名单。新设置的默认白名单会自动顶替原有默认白名单，即原有默认白名单会自动变为非默认白名单。更多详情，请参见约束与限制。

说明

若不设置该参数，表示不修改安全组。

若传入空数组（即 "SecurityGroupBindInfos":[]），表示清空安全组。

| |ClientToken |String |否 |WbiAlPqJM6tMoSOYhT\*\*\*\* |用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。 | ### SecurityGroupBindInfo |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |BindMode |String |是 |AssociateEcsIp |安全组关联模式。取值范围如下：

* `IngressDirectionIp`：入方向 IP，即允许安全组入方向的源地址中 TCP 协议和 ALL 协议涉及的 IP 访问数据库，若源地址中配置为安全组将被忽略。

* `AssociateEcsIp`：关联 ECS IP，即允许安全组内的云服务器访问数据库，当前仅支持主网卡的 IP 信息导入。

说明

关于安全组关联模式的更多详情，请参见创建白名单。

说明

您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。

单个白名单单次最多可选择添加 10 个安全组。

一个白名单最多支持 300 个 IP 或 IP 段，关联安全组涉及的 IP 或 IP 段超过限制时会关联失败，您可以调整安全组中的 IP 后重新关联。更多详情，请参见约束与限制。

| ## 返回参数本接口无特有的返回参数。更多信息请见[返回结构](https://docs.volcengine.com/docs/6293/65745)。 ## 示例 ## 请求示例 ```JSON POST https://redis.cn-beijing.volcengineapi.com/?Action=ModifyAllowList&Version=2020-12-07 HTTP/1.1 Host: redis.cn-beijing.volcengineapi.com Content-Type: application/json; charset=utf-8 X-Date: 20201103T104027Z Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=**** { "AllowListId": "acl-cnlf3xgczbjldzy****", "AllowListName": "test", "AllowList": "192.168.0.1", "ApplyInstanceNum": 1 } ``` ## 返回示例 ```JSON { "ResponseMetadata": { "RequestId": "202204151541400102120740810061****", "Action": "ModifyAllowList", "Version": "2020-12-07", "Service": "Redis", "Region": "cn-beijing" }, "Result": null } ``` ## 错误码更多详情，请参见[错误码](https://docs.volcengine.com/docs/6293/73664)。