文档首页/ 分布式缓存服务 DCS/ API参考（吉隆坡区域）/ API V2（推荐）/ 网络安全/ 设置IP白名单分组
更新时间：2025-11-14 GMT+08:00
在线调试
CLI示例
查看PDF
分享

设置IP白名单分组

功能介绍

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。可通过DCS控制台进入实例详情界面查看。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

instance_id

否

String

参数解释：

实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

enable_whitelist

是

Boolean

参数解释：

是否启用白名单。

约束限制：

不涉及。

取值范围：

true：启用白名单。

false：关闭白名单。

默认取值：

不涉及。

whitelist

是

Array of Whitelist objects

参数解释：

IP白名单分组列表，设置白名单分组信息会覆盖掉已有的白名单信息，因此在新增IP白名单分组时，需保留已有的白名单信息后再编辑新的白名单分组信息。

约束限制：

不涉及。
表3 Whitelist

参数

是否必选

参数类型

描述

group_name

是

String

参数解释：

白名单分组名称。

约束限制：

每个实例支持创建4个白名单分组，分组名称不能重复，必须大于四位，且首字段必须为字母，只能包含字母，数字，中划线，下划线。

取值范围：

不涉及。

默认取值：

不涉及。

ip_list

是

Array of strings

参数解释：

白名单分组下的IP列表。如果有多个，可以用逗号分隔。

约束限制：

单个实例下的IP不能重复，不支持IP部分为0.0.0.0的IP和CIDP。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：204

参数解释：

设置IP白名单成功。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

请求示例

  • 启用白名单，配置允许访问的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

参数解释：

内部错误。

错误码

请参见错误码。

父主题： 网络安全