CreateAllowList--缓存数据库 Redis 企业版-火山引擎

文档中心

立即注册

导航

CreateAllowList

最近更新时间：2024.12.18 21:07:29首次发布时间：2024.12.13 17:25:37

调用 CreateAllowList 接口创建一个新的 IP 白名单。

请求类型

同步请求。

注意事项

在缓存数据库 Redis 企业版中使用白名单时存在一些约束和限制，具体限制请参见创建白名单。

请求参数

参数	类型	是否必选	示例值	描述
AllowListName	String	是	test	白名单名称，名称需同时满足如下要求：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需为 1~32 个字符。
AllowList	String	否	10.1.1.1,10.2.3.0/24	输入 IP 地址或 CIDR 格式的地址段。说明 `AllowList` 和 `SecurityGroupBindInfos` 参数不可同时为空。不允许设置重复的地址，多个地址间用英文逗号（,）隔开。设置 `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 地址访问。除了 `0.0.0.0/0` 地址段之外，需要绑定到企业版实例的白名单中，所设置的 CIDR 地址段中不允许包含 `0.0.0.0` 地址，否则绑定到企业版实例时会报错。例如，白名单中设置了 `0.0.0.0/1` CIDR 格式地址段，那么企业版实例绑定到该白名单时会报错。
AllowListDesc	String	否	test	白名单的备注信息，长度不可超过 200 个字符。说明若不设置该参数，新建白名单的备注信息默认为空。
AllowListCategory	String	否	Default	白名单的类型。取值范围如下： `Ordinary`（默认值）：普通白名单。 `Default`：默认白名单。说明每个火山引擎账号在每个地域最多可设定一个默认白名单。新设置的默认白名单会自动顶替原有默认白名单，即原有默认白名单会自动变为非默认白名单。更多详情，请参见约束与限制。
SecurityGroupBindInfos	Object[]	否		需要关联的 ECS 安全组信息列表。说明 `AllowList` 和 `SecurityGroupBindInfos` 参数不可同时为空。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

参数	类型	示例值	描述
AllowListId	String	acl-cnlf3xgczbjldzy****	白名单 ID。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=CreateAllowList&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=****
{
	"AllowListName": "test",
	"AllowList": "10.1.1.1,10.2.3.0/24"
}

返回示例

{
     "ResponseMetadata": {
          "RequestId": "202204151541400102120740810061****",
          "Action": "CreateAllowList",
          "Version": "2020-12-07",
          "Service": "Redis",
          "Region": "cn-beijing"
     },
     "Result": {
          "AllowListId": "acl-cnlf3xgczbjldzy****"
     }
}

错误码

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