AssociateAllowList--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

AssociateAllowList

最近更新时间：2024.12.05 19:57:08首次发布时间：2022.05.18 12:01:49

调用 AssociateAllowList 接口将目标 Redis 实例绑定到指定 IP 白名单。

请求类型

异步请求。

注意事项

在缓存数据库 Redis 版中使用白名单时存在一些约束和限制，具体限制请参见创建白名单。
出于数据安全考虑，不允许在开启实例免密访问功能的同时，将地址 0.0.0.0/0 加入实例的白名单中。如需在白名单中设置地址 0.0.0.0/0，请先关闭实例的免密访问功能。免密访问功能设置方法，请参见 ModifyDBInstanceVpcAuthMode。

请求参数

参数	类型	是否必选	示例值	描述
InstanceIds	String[]	是	["redis-cn0212gzmh2xs****"]	需要绑定白名单的实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。支持一次传入多个实例 ID，多个 ID 间用英文逗号（,）分隔。不支持同时传入多个实例 ID 和白名单，即仅允许一次将多个实例同时绑定到同一个白名单，或将一个实例同时绑定到多个白名单。
AllowListIds	String[]	是	["acl-cn02f66vyjw7aj9**","acl-cn02iaiectnt2ls**"]	需要绑定实例的白名单 ID。说明您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单 ID。支持一次传入多个白名单 ID，多个 ID 间用英文逗号（,）分隔。不支持同时传入多个实例 ID 和白名单，即仅允许一次将多个实例同时绑定到同一个白名单，或将一个实例同时绑定到多个白名单。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=AssociateAllowList&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=****
{
    "InstanceIds": [
        "redis-cn0212gzmh2xs****"
    ],
    "AllowListIds": [
        "acl-cn02f66vyjw7aj9****",
        "acl-cn02iaiectnt2ls****"
    ]
}

返回示例

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

错误码

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