You need to enable JavaScript to run this app.
导航
缓存数据库 Redis 版
  • 文档首页
    • /
  • 缓存数据库 Redis 版

ModifyAllowList

最近更新时间：2023.07.28 15:54:47

首次发布时间：2022.05.18 12:01:49

我的收藏

调用 ModifyAllowList 接口修改目标白名单设置（例如白名单名称、IP 白名单地址等）。

请求类型

异步请求。

注意事项

出于数据安全考虑，不允许在开启实例免密访问功能的同时，将地址 0.0.0.0/0 加入实例的白名单中。如需在白名单中设置地址 0.0.0.0/0，请先关闭实例的免密访问功能。免密访问功能设置方法，请参见 ModifyDBInstanceVpcAuthMode。

请求参数

名称类型是否必选示例值描述

AllowListId

String

是

acl-cnlf3xgczbjldzy****

白名单 ID。

说明

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

AllowListName

String

是

test

白名单名称。

说明

  • 若需修改原白名单的 IP 地址，直接输入原白名单的名称即可。您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单名称。
  • 若需修改白名单名称，直接输入新的白名单名称即可。名称需同时满足如下要求：
    • 不能以数字、中划线（-）开头。
    • 只能包含中文、字母、数字、下划线（_）和中划线（-）。
    • 长度需为 1~32 个字符。

ModifyMode

String

否

Cover

修改方式，取值范围如下：

  • Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。
  • Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。
  • Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
AllowListDescString否test白名单的备注信息，长度不可超过 200 个字符。

AllowList

String

否

192.168.0.1

输入 IP 地址或 CIDR 格式的地址段。

说明

  • 仅当需要变更白名单中的 IP 地址时，该参数必填。
  • 每个白名单中最多支持设置 1000 个 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 地址访问。

ApplyInstanceNum

Integer

否

1

当前白名单所绑定的实例个数。

说明

  • 仅当需要修改 AllowList 参数时，该参数必填。
  • 您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单下绑定的实例总数。
ClientTokenString否WbiAlPqJM6tMoSOYhT****用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回数据

null

请求示例

POST https://redis.volcengineapi.com/?Action=ModifyAllowList&Version=2020-12-07 HTTP/1.1
Host: redis.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
}

返回示例

正常返回示例

{
     "ResponseMetadata": {
          "RequestId": "202204151541400102120740810061****",
          "Action": "ModifyAllowList",
          "Version": "2020-12-07",
          "Service": "Redis",
          "Region": "cn-beijing",
     },
     "Result": null
}

错误码

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