更新时间:2025-08-28 GMT+08:00
分享

更新IPS白名单

功能介绍

更新IPS白名单

调用方法

请参见如何调用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" ]
}

响应示例

状态码:200

响应数据

{ }

状态码

状态码

描述

200

响应数据

400

Bad Request

错误码

请参见错误码

相关文档