文档首页/ 云防火墙 CFW/ API参考/ API/ IPS管理/ 更新自定义IPS规则
更新时间:2025-08-12 GMT+08:00

更新自定义IPS规则

功能介绍

更新自定义IPS规则

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/ips/custom-rule/{ips_cfw_id}

表1 路径参数

参数

是否必选

参数类型

描述

ips_cfw_id

String

参数解释

cfw侧自定义IPS规则id

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

project_id

String

参数解释

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

action_type

Integer

参数解释

动作

取值范围

0:只记录日志,1:重置/拦截

affected_os

Integer

参数解释

影响操作系统

取值范围

0 any、1 Windows、2 Linux、3 FreeBSD、4 Solaris、5 other Unix、6 网络设备、7 Mac OS、8 ios、9 android、10 others

attack_type

Integer

参数解释

攻击类型

约束限制

不涉及

取值范围

1:访问控制、2:漏洞扫描、3:邮件攻击、4:漏洞攻击、5:Web攻击、6:密码攻击、7:劫持攻击、8:协议异常、9:特洛伊木马、10:蠕虫、11:缓冲区溢出、12:黑客工具、13:间谍软件、14:DDos泛洪、15:应用层DDos攻击、16:其他可疑行为、17:可疑DNS活动、18:网络钓鱼、19:垃圾邮件、20:其他攻击

默认取值

不涉及

contents

Array of IpsContent objects

参数解释

匹配IPS攻击的内容

取值范围

direction

Integer

参数解释

默认:null,0:客户端到服务端,1:服务端到客户端

取值范围

不涉及

dst_port

Port object

fw_instance_id

String

参数解释

防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

ips_name

String

参数解释

ips规则名称

取值范围

不涉及

protocol

Integer

参数解释

协议类型

取值范围

1 FTP、2 TELNET、3 SMTP、4 DNS_TCP、5 DNS_UDP、6 DHCP、7 TFTP、8 FINGER、9 HTTP、10 POP3、11 SUNRPC_TCP、12 SUNRPC_UDP、13 NNTP、14 MSRPC_TCP、15 MSRPC_UDP、16 NETBIOS_NAME_TCP、17 NETBIOS_NAME_UDP、18 NETBIOS_SMB、19 NETBIOS_DATAGRAM、20 IMAP4、21 SNMP、22 LDAP、23 MSSQL、24 ORACLE

severity

Integer

参数解释

严重程度

取值范围

critical:致命,high:高危,medium:中危,low:低危

software

Integer

参数解释

影响软件

取值范围

0 ANY、1 ADOBE、2 APACHE、3 APPLE、4 CA、5 CISCO、6 GOOGLE_CHROME、7 HP、8 IBM、9 IE、10 IIS、11 MC_AFEE、12 MEDIA_PLAYER、13 MICROSOFT_NET、14 MICROSOFT_EDGE、15 MICROSOFT_EXCHANGE、16 MICROSOFT_OFFICE、17 MICROSOFT_OUTLOOK、18 MICROSOFT_SHARE_POINT、19 MICROSOFT_WINDOWS、20 MOZILLA、21 MSSQL、22 MYSQL、23 NOVELL、24 ORACLE、25 SAMBA、26 SAMSUNG、27 SAP、28 SCADA、29 SQUID、30 SUN、31 SYMANTEC、32 TREND_MICRO、33 VMWARE、34 WORD_PRESS、35 Others

src_port

Port object

表3 IpsContent

参数

是否必选

参数类型

描述

content

String

参数解释

内容

取值范围

不涉及

depth

Integer

参数解释

深度

取值范围

不涉及

is_hex

Boolean

参数解释

报文内容是否为十六进制

取值范围

不涉及

is_ignore

Boolean

参数解释

是否忽略大小写

取值范围

不涉及

is_uri

Boolean

参数解释

是否在uri中截取报文

取值范围

不涉及

offset

Integer

参数解释

偏移量

取值范围

不涉及

relative_position

Integer

参数解释

相对位置

取值范围

不涉及

表4 Port

参数

是否必选

参数类型

描述

port_type

Integer

参数解释

端口类型

取值范围

-1 Any,0 包含,1 排除

ports

String

参数解释

端口

取值范围

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

data

data object

参数解释

更新自定义IPS规则响应数据

取值范围

不涉及

表6 data

参数

参数类型

描述

id

String

参数解释

防火墙id

取值范围

不涉及

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及

error_msg

String

参数解释

错误描述

取值范围

不涉及

请求示例

更新项目id为3d84b4755b39476997c9f7b5a95c25ed,ips_cfw_id为cd74e74a-310f-4558-a4bf-da4215c820f8的自定义IPS规则

https://{Endpoint}/v1/3d84b4755b39476997c9f7b5a95c25ed/ips/custom-rule/cd74e74a-310f-4558-a4bf-da4215c820f8

{
  "fw_instance_id" : "d6e0a4d0-8b16-47fe-98b6-e1b0a7a14788",
  "ips_name" : "test_操作系统linux",
  "direction" : -1,
  "src_port" : {
    "port_type" : -1
  },
  "dst_port" : {
    "port_type" : -1
  },
  "contents" : [ {
    "content" : "ab",
    "is_hex" : false,
    "is_ignore" : false,
    "is_uri" : false,
    "relative_position" : 0,
    "offset" : 0,
    "depth" : 65535
  } ],
  "action_type" : 1,
  "severity" : 0,
  "attack_type" : 1,
  "software" : 0,
  "affected_os" : 1,
  "protocol" : 9
}

响应示例

状态码:200

OK

{
  "data" : {
    "id" : "64b8978e-20c0-4b43-b178-885e3cbb380d"
  }
}

状态码:400

Bad Request

{
  "error_code" : "CFW.00200003",
  "error_msg" : "参数错误"
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码