接口功能介绍
更新防护规则接口
接口约束
请保证ruleId存在
URI
POST /vfw/v2_system_sec_policy_update
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
urlType | 是 | String | 请求地址类型 | CTAPI | |
regionId | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
ruleId | 是 | Long | 规则ID | 321 | |
ruleName | 是 | String | 规则名称 | test | |
firewallId | 是 | String | 防火墙id | dca4f9ffaca2447aa24310c1e62c4690 | |
ipProto | 是 | String | IP协议,可能值 v4,v6。 | v4 | |
direction | 是 | String | 方向,可能值 in,out。 | in | |
action | 否 | String | 动作,可能值 drop,pass。 | pass | |
dstIp | 否 | String | 目的IP V4必输 | 1.1.1.0 | |
dstIpMask | 否 | Integer | 目的IP子网掩码 V4必输 | 24 | |
dstIp6 | 否 | String | 目的IP6 V6必输 | 1:: | |
dstIp6Mask | 否 | Integer | 目的IP6子网掩码 V6必输 | 96 | |
srcIp | 否 | String | 源IP V4必输 | 2.2.2.0 | |
srcIpMask | 否 | Integer | 源IP子网掩码 V4必输 | 24 | |
srcIp6 | 否 | String | 源IP6 V6必输 | 2:: | |
srcIp6Mask | 否 | Integer | 源IP6子网掩码 V6必输 | 96 | |
service | 否 | String | 服务类型,可能值 any,icmp,tcp,udp。 | tcp | |
dstPort | 否 | String | 目的端口 | 8080 | |
srcPort | 否 | String | 源端口 | 8182 | |
icmpType | 否 | String | icmpType | ||
icmpCode | 否 | String | icmpCode | ||
app | 否 | String | 应用ID 多个ID用逗号隔开 | 20,30 | |
status | 否 | String | 规则开关,可能值 disable,enable。 | disable | |
statistics | 否 | String | 统计开关,可能值 disable,enable。 | disable | |
policyDesc | 否 | String | 防护规则描述 | 防护规则描述 | |
pos | 否 | String | 移动策略ID到最前或最后,可能值 head,remove,tail。 | head | |
act | 否 | String | 基于目标策略ID移动类型, 可能值 after,before。 priority,act和pos三选一 |
after | |
base | 否 | Long | 目标策略ID, 当act有效时, 必传 | 2222 | |
srcIpGroupId | 否 | Integer | 源地址组id | 1 | |
dstIpGroupId | 否 | Integer | 目的地址组id | 1 | |
srcPortGroupId | 否 | Integer | 源端口组id | 2 | |
dstPortGroupId | 否 | Integer | 目的端口组id | 2 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 | ||
message | String | 返回信息 | 成功 | |
error | String | 错误码:CFW_0000 :成功!;CFW_0001:参数错误!;CFW_0002:业务错误! | CFW_0000 | |
returnObj | Object | 接口返回结果 | null |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
请求体body
{
"firewallId": "91e76b89efea420595fd859baf4eb2e4",
"direction": "out",
"ruleName": "123",
"ipProto": "v4",
"srcPort": "1",
"srcIpGroupId": 9,
"dstPort": "10",
"dstIpGroupId": 1,
"action": "drop",
"policyDesc": "",
"status": "disable",
"service": "tcp",
"app": "",
"ruleId": "17053"
}
响应示例
{
"statusCode": "800",
"error": "CFW_0000",
"message": "成功!"
}
状态码
请参考 状态码
错误码
请参考 错误码