接口功能介绍

新增防护规则接口

接口约束

传参校验

URI

POST /vfw/v2_system_sec_policy_add

路径参数 无

Query参数 无

请求参数

请求头header参数

参数	是否必填	参数类型	说明	示例	下级对象
urlType	是	String	请求地址类型	CTAPI
regionId	是	String	资源池id	100054c0416811e9a6690242ac110002

请求体body参数

参数	是否必填	参数类型	说明	示例
ruleName	是	String	规则名称	test
firewallId	否	String	防火墙id和类型必须填一个	dca4f9ffaca2447aa24310c1e62c4690
firewallType	否	String	NorthSouth/EastWeat防火墙id和类型必须填一个	NorthSouth
ipProto	是	String	IP协议，可能值 v4,v6。	v4
direction	是	String	方向，可能值 in,out。	in
action	否	String	动作，可能值 drop,pass。	pass
dstIp	否	String	目的IP，防火墙类型isNfw=0使用这个参数	1.1.1.0
dstIps	否	Array of Strings	目的IP列表，防火墙类型isNfw=1使用这个参数
dstIpMask	否	Integer	目的IP子网掩码，防火墙类型isNfw=0使用这个参数	24
srcIp	否	String	源IP，防火墙类型isNfw=0使用这个参数	2.2.2.0
srcIps	否	Array of Strings	源IP列表，防火墙类型isNfw=1使用这个参数
srcIpMask	否	Integer	源IP子网掩码，防火墙类型isNfw=0使用这个参数	24
service	否	String	服务类型，可能值 any,icmp,tcp,udp。	tcp
dstPort	否	String	目的端口，防火墙类型isNfw=0使用这个参数	8080
dstPorts	否	Array of Strings	目的端口列表，防火墙类型isNfw=1使用这个参数
srcPort	否	String	源端口，防火墙类型isNfw=0使用这个参数	8182
srcPorts	否	Array of Strings	源端口列表，防火墙类型isNfw=1使用这个参数
app	否	String	应用ID	20,30
status	否	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，防火墙类型isNfw=0使用这个参数	1
srcIpGroupIds	否	Array of Strings	源地址组ids，防火墙类型isNfw=1使用这个参数	["2"]
dstIpGroupId	否	Integer	目的地址组id，防火墙类型isNfw=0使用这个参数	1
dstIpGroupIds	否	Array of Strings	目的地址组ids，防火墙类型isNfw=1使用这个参数	["2"]
srcPortGroupId	否	Integer	源端口组id，防火墙类型isNfw=0使用这个参数	2
srcPortGroupIds	否	Array of Strings	源端口组ids，防火墙类型isNfw=1使用这个参数	["2"]
dstPortGroupId	否	Integer	目的端口组id，防火墙类型isNfw=0使用这个参数	2
dstPortGroupIds	否	Array of Strings	目的端口组ids，防火墙类型isNfw=1使用这个参数	["2"]

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	String	状态码
message	String	返回信息	成功
error	String	错误码：CFW_0000 :成功!;CFW_0001:参数错误！;CFW_0002：业务错误！	CFW_0000
returnObj	Object	接口返回结果		SystemSecPolicyEntity
表 SystemSecPolicyEntity

参数	参数类型	说明	示例
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，防火墙类型isNfw=1用,分割	1.1.1.0
dstIpMask	Integer	目的IP子网掩码防火墙类型isNfw=0有返回	24
srcIp	String	源IP，防火墙类型isNfw=1用,分割	2.2.2.0
srcIpMask	Integer	源IP子网掩码防火墙类型isNfw=0有返回	24
service	String	服务类型，可能值 any,icmp,tcp,udp。	tcp
dstPort	String	目的端口，防火墙类型isNfw=1用,分割	8080
srcPort	String	源端口，防火墙类型isNfw=1用,分割	8182
app	String	应用ID	20
status	String	规则开关，可能值 disable,enable。	disable
policy	Integer	优先级	1
policyDesc	String	防护规则描述	防护规则描述
srcIpGroupId	String	源ip组id，防火墙类型isNfw=1用,分割
dstIpGroupId	String	目的ip组id，防火墙类型isNfw=1用,分割
srcPortGroupId	String	源端口组id，防火墙类型isNfw=1用,分割
dstPortGroupId	String	目的端口组id，防火墙类型isNfw=1用,分割
srcIpGroupName	String	源地址组名称，防火墙类型isNfw=1用,分割
dstIpGroupName	String	目的地址组名称，防火墙类型isNfw=1用,分割
srcPortGroupName	String	源端口组名称，防火墙类型isNfw=1用,分割
dstPortGroupName	String	目的端口组名称，防火墙类型isNfw=1用,分割

枚举参数

无

请求示例

请求url

无

请求头header

{
	"regionid": "100054c0416811e9a6690242ac110002",
	"urlType": "CTAPI"
}

请求体body

{
  "firewallId": "91e76b89efea420595fd859baf4eb2e4",
  "direction": "out",
  "ruleName": "1",
  "ipProto": "v4",
  "srcPort": "1",
  "srcIpGroupId": 9,
  "dstPort": "0",
  "dstIpGroupId": 2,
  "action": "drop",
  "policyDesc": "",
  "status": "disable",
  "service": "tcp",
  "pos": "tail",
  "app": ""
}

响应示例

{
	"statusCode": "800",
	"error": "CFW_0000",
	"message": "成功!",
	"returnObj": {
        "createTime": 1729836297437,
        "updateTime": 1729836297437,
        "ruleId": "17052",
        "ruleName": "1",
        "uid": "6069fd7ea3b943a287fea8de5ade38ab",
        "regionId": "b342b77ef26b11ecb0ac0242ac110002",
        "firewallId": "91e76b89efea420595fd859baf4eb2e4",
        "ipProto": "v4",
        "direction": "out",
        "action": "drop",
        "service": "tcp",
        "dstPort": "0",
        "srcPort": "1",
        "app": "",
        "status": "disable",
        "policyDesc": "",
        "quota": 1,
        "pos": "tail",
        "srcIpGroupId": 9,
        "dstIpGroupId": 2,
        "srcIpGroupName": "test",
        "dstIpGroupName": "test-chc-002"
    }
}

状态码

请参考状态码

错误码

请参考错误码

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

云防火墙（原生版）

云防火墙（原生版）

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

云防火墙（原生版）

云防火墙（原生版）

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码