文档首页/分布式缓存服务 DCS/API参考/API V2（推荐）/网络安全/添加ip白名单分组 - AddIpWhitelist
更新时间：2025-10-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

添加ip白名单分组 - AddIpWhitelist

功能介绍

为指定实例添加IP白名单分组。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v2/{project_id}/instance/{instance_id}/whitelist-async

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

whitelist

是

Array of Whitelist objects

参数解释：

需要添加的IP白名单分组列表,支持IP或CIDR。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表3 Whitelist

参数

是否必选

参数类型

描述

group_name

是

String

参数解释：

白名单分组名称。

约束限制：

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

取值范围：

不涉及。

默认取值：

不涉及。

ip_list

是

Array of strings

参数解释：

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

约束限制：

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

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

job_id

String

参数解释：

添加IP白名单分组任务ID。

取值范围：

不涉及。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

请求示例

POST https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist-async

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

响应示例

状态码：200

添加IP白名单分组返回体。

{
  "job_id" : "ff8080817fe01bb2017fe3cf68860481"
}

状态码

状态码

描述

200

添加IP白名单分组返回体。

400

非法请求。

401

认证失败。

403

请求被拒绝。

404

路径错误。

500

内部错误。

错误码

请参见错误码。

父主题： 网络安全

相关文档