更新IPS白名单 - UpdateIpsWhitelist

功能介绍

更新IPS白名单

调用方法

请参见如何调用API。

授权信息

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

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

URI

PUT /v1/{project_id}/cfw/{fw_instance_id}/ips/whitelist/{list_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以从调API处获取，也可以从控制台获取。项目ID获取方式约束限制：不涉及取值范围： 32位UUID 默认取值：不涉及
fw_instance_id	是	String	参数解释：防火墙ID，用户创建防火墙实例后产生的唯一ID，配置后可区分不同防火墙，可通过防火墙ID获取方式获取约束限制：不涉及取值范围： 32位UUID 默认取值：不涉及
list_id	是	String	参数解释白名单id 约束限制：不涉及取值范围：不涉及默认取值：不涉及

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
source_address	是	String	参数解释：白名单源地址约束限制：不涉及取值范围：不涉及默认取值：不涉及
dest_address	是	String	参数解释：目的地址约束限制：不涉及取值范围：不涉及默认取值：不涉及
ip_version	是	Integer	参数解释： IP类型约束限制：不涉及取值范围： 4：表示IP类型为IPv4 6：表示IP类型为IPv6 默认取值：不涉及
name	是	String	参数解释：白名单名称约束限制：不涉及取值范围：不涉及默认取值：不涉及
ips_id	否	String	参数解释： ips规则id，不填写时默认为全部ips规则约束限制：不涉及取值范围：不涉及默认取值：不涉及
effective_scopes	是	Array of strings	参数解释：生效范围：NAT EIP VPC HCS场景中还有VGW信息约束限制：不涉及取值范围：不涉及默认取值：不涉及

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
data	data object	参数解释返回数据取值范围：不涉及

表4 data
参数	参数类型	描述
ips_whitelist_id	String	参数解释白名单id 取值范围：不涉及

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码取值范围：不涉及
error_msg	String	参数解释：错误描述取值范围：不涉及

请求示例

更新ID为4bf99009-e595-4cd4-bde1-e88c18861ec5的IPS白名单

https://{Endpoint}/v1/eefb11b22d5944f2aa067954516df1cf/cfw/175572ed-67e8-4837-9776-e2e07080ea45/ips/whitelist/4bf99009-e595-4cd4-bde1-e88c18861ec5

{
  "name" : "test-002",
  "ip_version" : 4,
  "source_address" : "8.8.8.0/32",
  "dest_address" : "8.8.8.0/32",
  "effective_scopes" : [ "EIP" ]
}