文档首页/ 分布式缓存服务 DCS/ API参考（巴黎区域）/ API V2（推荐）/ 网络安全/ 设置IP白名单分组
更新时间：2023-12-13 GMT+08:00
查看PDF
分享

设置IP白名单分组

功能介绍

为指定实例设置IP白名单分组，包含创建、停用、编辑、删除白名单四个功能。设置白名单分组信息会覆盖掉已有的白名单信息，因此在新增IP白名单分组时，需保留已有的白名单信息后再编辑新的白名单分组信息。

URI

PUT /v2/{project_id}/instance/{instance_id}/whitelist

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID。

instance_id

是

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

instance_id

否

String

实例ID。

enable_whitelist

是

Boolean

是否启用白名单（true/false）。

枚举值：

  • true

  • false

whitelist

是

Array of Whitelist objects

IP白名单分组列表。
表3 Whitelist

参数

是否必选

参数类型

描述

group_name

是

String

白名单分组名称，每个实例支持创建4个分组。

ip_list

是

Array of strings

白名单分组下的IP列表,每个实例最多可以添加20个IP地址/地址段。如果有多个，可以用逗号分隔。不支持的IP和地址段：0.0.0.0和0.0.0.0/0。

响应参数

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

请求示例

  • 启用白名单，配置允许访问的IP地址。

    PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist

{
  "enable_whitelist" : true,
  "whitelist" : [ {
    "group_name" : "test001",
    "ip_list" : [ "10.10.10.1", "10.10.10.2" ]
  } ]
}

  • 启用白名单，配置允许访问的子网掩码。

    PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist

响应示例

无

状态码

状态码

描述

204

设置IP白名单成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误

错误码

请参见错误码。

父主题： 网络安全