数据结构

AcListsData

访问控制列表对象

被如下接口引用：DescribeAcLists。

名称	类型	描述
Id	Integer	规则id 示例值：9527
SourceIp	String	访问源 示例值：1.1.1.1
TargetIp	String	访问目的 示例值：1.1.1.1
Protocol	String	协议 示例值：TCP
Port	String	端口 示例值：3306
Strategy	Integer	策略 示例值：1
Detail	String	描述 示例值：andy的规则
Count	Integer	命中次数 示例值：1
OrderIndex	Integer	执行顺序 示例值：1
LogId	String	告警规则id 示例值：kYtiGTORZGin
Status	Integer	规则开关状态 1打开 0关闭 示例值：1
SrcType	Integer	规则源类型 示例值：4
DstType	Integer	规则目的类型 示例值：4
Uuid	String	规则唯一ID 示例值：1300448058_0.0.0.0/0_1729668688045166
Invalid	Integer	规则有效性 1 有效 0 无效 示例值：1
IsRegion	Integer	是否地域规则 示例值：1
CloudCode	String	云厂商代码 示例值：tencent
AutoTask	String	自动化助手信息 示例值：{"TaskId":"9001","TaskName":"autotest","LastTime":"1999-01-01 00:00:01"}
InstanceName	String	实例名称 示例值：andy的cvm
RegionCode	String	地域码信息 示例值：ap-guangzhou
Country	Integer	国家代码 示例值：86
City	Integer	城市代码 示例值：2
RegName1	String	国家名称 示例值：新加坡
RegName2	String	城市名称 示例值：北京

AssetZone

AssetZone

被如下接口引用：DescribeSourceAsset。

名称	类型	描述
Zone	String	地域 示例值：上海
ZoneEng	String	地域英文 示例值：ap-shanghai

AssociatedInstanceInfo

企业安全组关联实例信息

被如下接口引用：DescribeAssociatedInstanceList。

名称	类型	必选	描述
InstanceId	String	是	实例ID 示例值：eni-4ymwnaoe
InstanceName	String	是	实例名称 示例值：private1
Type	Integer	是	实例类型，3是cvm实例,4是clb实例,5是eni实例,6是云数据库 示例值：6
VpcId	String	是	私有网络ID 示例值：vpc-406waega
VpcName	String	是	私有网络名称 示例值：vpc4
PublicIp	String	是	公网IP 示例值：11.11.11.11
Ip	String	是	内网IP 示例值：192.168.0.13,192.168.0.3
SecurityGroupCount	Integer	是	关联安全组数量 示例值：0
SecurityGroupRuleCount	Integer	否	关联安全组规则数量 示例值：0
CdbId	String	否	关联数据库代理Id 示例值：192.168.0.13/24

BanAndAllowRule

封禁列表和放通列表结构体

被如下接口引用：CreateBlockIgnoreRuleNew, ModifyBlockIgnoreRuleNew。

名称	类型	必选	描述
Comment	String	否	规则评论 示例值：生产环境放通
CustomRule	CustomWhiteRule	否	自定义白名单规则 示例值：{"DstIP":"10.12.11.1","IdsRuleId":"20001","IdsRuleName":"正常业务","SrcIP":"10.12.11.2"}
DirectionList	String	否	0互联网出站 1互联网入站 5内网访问源 6内网访问目的 示例值：0,1
EndTime	String	否	规则截止时间 示例值：3000-01-01 00:00:00
FwType	Integer	否	放通的引擎: 1针对互联网边界 2针对nat防火墙 4针对vpc防火墙 示例值：1
Ioc	String	否	封禁和放通对象 示例值：1.2.3.4

BanAndAllowRuleDel

封禁列表和放通列表结构体

被如下接口引用：DeleteBlockIgnoreRuleNew。

名称	类型	必选	描述
Ioc	String	否	封禁和放通对象 示例值：1.2.3.4
DirectionList	String	否	0互联网出站 1互联网入站 5内网访问源 6内网访问目的 （DeleteBlockIgnoreRuleNew接口，该字段无效） 示例值：0,1
RuleType	Integer	否	规则类型 RuleType: 1黑名单 2外部IP 3域名 4情报 5资产 6自定义规则 7入侵防御规则 示例值：1

BetaInfoByACL

规则关联的beta任务

被如下接口引用：AddVpcAcRule, DescribeAclRule, DescribeNatAcRule, DescribeVpcAcRule, ModifyVpcAcRule。

名称	类型	必选	描述
TaskId	Integer	否	任务id 示例值：1001
TaskName	String	否	任务名称 示例值：任务名称
LastTime	String	否	上次执行时间 示例值：2023-03-02 10:00:00

BlockIgnoreRule

入侵防御放通封禁规则

被如下接口引用：DescribeBlockIgnoreList。

名称	类型	描述
RuleType	Integer	规则类型，取值：1 封禁，2外部IP，3域名，4情报，5assets，6自定义策略，7入侵防御规则id （2-7属于白名单类型） 示例值：1
Ioc	String	规则ip或白名单内容 示例值：1.1.1.1
IocName	String	资产实例名称、自定义策略名称等 示例值：名称名称
IocInfo	String	白名单信息 示例值：广东省深圳市
Domain	String	域名 示例值：www.test.com
IP	String	IP 示例值：1.1.1.1
Level	String	危险等级 示例值：高危
EventName	String	来源事件名称 示例值：封禁列表命中
Direction	Integer	方向：1入站，0出站 示例值：1
DirectionList	String	所有方向聚合成字符串 示例值：0,1
Protocol	String	协议 示例值：TCP
Address	String	地理位置 示例值：中国广东省广州
Action	Integer	规则类型：1封禁，2放通 示例值：1
StartTime	String	规则生效开始时间 示例值：2021-09-21 12:00:00
EndTime	String	规则生效结束时间 示例值：3000-01-01 00:00:00
IgnoreReason	String	忽略原因 示例值：0
Source	String	安全事件来源 示例值：手动添加
UniqueId	String	规则id 示例值：UniqueId
MatchTimes	Integer	规则命中次数 示例值：1
Country	String	国家 示例值：中国
Comment	String	备注 示例值：comment
LastHitTime	String	上次命中时间 示例值：2021-09-21 12:00:00
CustomRule	CustomWhiteRule	自定义规则细节 示例值：{"SrcIP":"0.0.0.0/0","DstIP":"1.1.1.1","IdsRuleName":"全放通","IdsRuleId":"20003"}
FwType	Integer	1 border 2 nat 4 vpc 8 border-serial 示例值：1

CfwNatDnatRule

NAT防火墙Dnat规则

被如下接口引用：SetNatFwDnatRule。

名称	类型	必选	描述
IpProtocol	String	是	网络协议，可选值：TCP、UDP。 示例值：TCP
PublicIpAddress	String	是	弹性IP。 示例值：175.27.187.125
PublicPort	Integer	是	公网端口。 示例值：80
PrivateIpAddress	String	是	内网地址。 示例值：10.10.1.1
PrivatePort	Integer	是	内网端口。 示例值：80
Description	String	是	NAT防火墙转发规则描述。 示例值：自定义描述

CommonFilter

通用的列表检索过滤选项

被如下接口引用：DescribeAclRule, DescribeEnterpriseSecurityGroupRuleList, DescribeFwEdgeIps, DescribeFwGroupInstanceInfo, DescribeIdsWhiteRule, DescribeLogs, DescribeNatAcRule, DescribeNatFwDnatRule, DescribeVpcAcRule, DescribeVpcFwGroupSwitch。

名称	类型	必选	描述
Name	String	是	检索的键值 示例值：src_ip
OperatorType	Integer	是	枚举类型，代表Name与Values之间的匹配关系 enum FilterOperatorType { //等于 FILTER_OPERATOR_TYPE_EQUAL = 1; //大于 FILTER_OPERATOR_TYPE_GREATER = 2; //小于 FILTER_OPERATOR_TYPE_LESS = 3; //大于等于 FILTER_OPERATOR_TYPE_GREATER_EQ = 4; //小于等于 FILTER_OPERATOR_TYPE_LESS_EQ = 5; //不等于 FILTER_OPERATOR_TYPE_NO_EQ = 6; //not in FILTER_OPERATOR_TYPE_NOT_IN = 8; //模糊匹配 FILTER_OPERATOR_TYPE_FUZZINESS = 9; } 示例值：1
Values	Array of String	是	检索的值，各检索值间为OR关系 示例值：["1.1.1.1","2.2.2.2"]

CreateNatRuleItem

创建NAT ACL规则参数结构

被如下接口引用：AddNatAcRule, ModifyNatAcRule。

名称	类型	必选	描述
SourceContent	String	是	访问源示例： net：IP/CIDR(192.168.0.2) 示例值：192.168.0.2
SourceType	String	是	访问源类型：入向规则时类型可以为 ip,net,template,location；出向规则时可以为 ip,net,template,instance,group,tag 示例值：ip
TargetContent	String	是	访问目的示例： net：IP/CIDR(192.168.0.2) domain：域名规则，例如.qq.com 示例值：.qq.com
TargetType	String	是	访问目的类型：入向规则时类型可以为ip,net,template,instance,group,tag；出向规则时可以为 ip,net,domain,template,location 示例值：domain
Protocol	String	是	协议，可选的值： TCP UDP ICMP ANY HTTP HTTPS HTTP/HTTPS SMTP SMTPS SMTP/SMTPS FTP DNS 示例值：TCP
RuleAction	String	是	访问控制策略中设置的流量通过云防火墙的方式。取值： accept：放行 drop：拒绝 log：观察 示例值：accept
Port	String	是	访问控制策略的端口。取值： -1/-1：全部端口 80：80端口 示例值：-1/-1
Direction	Integer	是	规则方向：1，入站；0，出站 示例值：0
OrderIndex	Integer	是	规则序号 示例值：1
Enable	String	否	规则状态，true表示启用，false表示禁用 示例值：true
Uuid	Integer	否	规则对应的唯一id，创建规则时无需填写 示例值：8888
Description	String	否	描述 示例值：自定义描述
ParamTemplateId	String	否	端口协议组ID 示例值：pp-1q2w3e4r
InternalUuid	Integer	否	内部id 示例值：8888
Scope	String	否	规则生效的范围：ALL，全局生效；ap-guangzhou，生效的地域；cfwnat-xxx，生效基于实例维度 示例值：ap-guangzhou

CreateRuleItem

创建互联网边界规则参数结构

被如下接口引用：AddAclRule, ModifyAclRule。

名称	类型	必选	描述
SourceContent	String	是	访问源示例： net：IP/CIDR(192.168.0.2) 示例值：192.168.0.2
SourceType	String	是	访问源类型：入向规则时类型可以为 ip,net,template,location；出向规则时可以为 ip,net,template,instance,group,tag 示例值：ip
TargetContent	String	是	访问目的示例： net：IP/CIDR(192.168.0.2) domain：域名规则，例如.qq.com 示例值：.qq.com
TargetType	String	是	访问目的类型：入向规则时类型可以为ip,net,template,instance,group,tag；出向规则时可以为 ip,net,domain,template,location 示例值：domain
Protocol	String	是	协议，可选的值： TCP UDP ICMP ANY HTTP HTTPS HTTP/HTTPS SMTP SMTPS SMTP/SMTPS FTP DNS 1. 入方向 旁路防火墙/全局规则 仅支持TCP 2.出方向 旁路防火墙/全局规则 仅支持TCP HTTP/HTTPS TLS/SSL 3.domain 请选择七层协议 如HTTP/HTTPS 示例值：TCP
RuleAction	String	是	访问控制策略中设置的流量通过云防火墙的方式。取值： accept：放行 drop：拒绝 log：观察 示例值：accept
Port	String	是	访问控制策略的端口。取值： -1/-1：全部端口 80：80端口 示例值：-1/-1
Direction	Integer	是	规则方向：1，入站；0，出站 示例值：0
OrderIndex	Integer	是	规则序号 示例值：1
Uuid	Integer	否	规则对应的唯一id，创建规则时无需填写 示例值：8888
Enable	String	否	规则状态，true表示启用，false表示禁用 示例值：true
Description	String	否	描述 示例值：自定义描述
Scope	String	否	all 示例值：生效范围：serial，串行；side，旁路；all，全局
RuleSource	Integer	否	0，正常规则添加；1，入侵检测添加 示例值：0
LogId	String	否	告警Id 示例值：987c1bb3-f975-4055-a0f9-40beab3633da
ParamTemplateId	String	否	端都协议组ID 示例值：pp-1q2w3e4r

CustomWhiteRule

自定义白名单规则

被如下接口引用：CreateBlockIgnoreRuleNew, DescribeBlockIgnoreList, ModifyBlockIgnoreRuleNew。

名称	类型	必选	描述
DstIP	String	否	访问目的 示例值：101.12.11.2
IdsRuleId	String	否	规则ID 示例值：20001
IdsRuleName	String	否	规则名称 示例值：自定义规则名称
SrcIP	String	否	访问源 示例值：101.12.11.1

DatabaseWhiteListRuleData

数据库白名单规则数据

被如下接口引用：CreateDatabaseWhiteListRules。

名称	类型	必选	描述
SourceIp	String	是	访问源 示例值：1.1.1.1
SourceType	Integer	是	访问源类型，1 ip；6 实例；100 资源分组 示例值：1
TargetIp	String	是	访问目的 示例值：cdb-123
TargetType	Integer	是	访问目的类型，1 ip；6 实例；100 资源分组 示例值：1
Detail	String	是	规则描述 示例值：自定义描述
IsRegionRule	Integer	是	是否地域规则，0不是 1是 示例值：0
IsCloudRule	Integer	是	是否云厂商规则，0不是 1 时 示例值：0
Enable	Integer	是	是否启用，0 不启用，1启用 示例值：1
FirstLevelRegionCode	Integer	否	地域码1 示例值：0
SecondLevelRegionCode	Integer	否	地域码2 示例值：0
FirstLevelRegionName	String	否	地域名称1 示例值：中国
SecondLevelRegionName	String	否	地域名称2 示例值：广东
CloudCode	String	否	云厂商码 示例值：0

DescAcItem

访问控制列表对象

被如下接口引用：DescribeAclRule, DescribeNatAcRule。

名称	类型	描述
SourceContent	String	访问源 示例值：1.1.1.1
TargetContent	String	访问目的 示例值：1.1.1.1
Protocol	String	协议 示例值：TCP
Port	String	端口 示例值：80
RuleAction	String	访问控制策略中设置的流量通过云防火墙的方式。取值： accept：放行 drop：拒绝 log：观察 示例值：accept
Description	String	描述 示例值：自定义描述
Count	Integer	命中次数 示例值：1
OrderIndex	Integer	执行顺序 示例值：1
SourceType	String	访问源类型：入向规则时类型可以为 ip,net,template,location；出向规则时可以为 ip,net,template,instance,group,tag 示例值：ip
TargetType	String	访问目的类型：入向规则时类型可以为ip,net,template,instance,group,tag；出向规则时可以为 ip,net,domain,template,location,dnsparse 示例值：ip
Uuid	Integer	规则对应的唯一id 示例值：8888
Invalid	Integer	规则有效性 示例值：0
IsRegion	Integer	0为正常规则,1为地域规则 示例值：0
CountryCode	Integer	国家id 示例值：0
CityCode	Integer	城市id 示例值：0
CountryName	String	国家名称 示例值：中国
CityName	String	省名称 示例值：广东省
CloudCode	String	云厂商code 示例值：0
IsCloud	Integer	0为正常规则,1为云厂商规则 示例值：0
Enable	String	规则状态，true表示启用，false表示禁用 示例值：true
Direction	Integer	规则方向：1，入向；0，出向 示例值：0
InstanceName	String	实例名称 示例值：内部接口实例
InternalUuid	Integer	内部使用的uuid，一般情况下不会使用到该字段 示例值：87539
Status	Integer	规则状态，查询规则命中详情时该字段有效，0：新增，1: 已删除, 2: 编辑删除 示例值：0
BetaList	Array of BetaInfoByACL	关联任务详情 示例值：[{"TaskId":0,"TaskName":"test","LastTime":"2024-09-22 11:22:11"}]
Scope	String	（1）互联网边界防火墙，生效范围：serial，串行；side，旁路；all，全局； （2）NAT边界防火墙：ALL，全局生效；ap-guangzhou，生效的地域；cfwnat-xxx，生效基于实例维度 示例值：all
ScopeDesc	String	生效范围描述 示例值：全局规则
InternetBorderUuid	String	互联网边界防火墙使用的内部规则id 示例值：互联网边界Uuid
ParamTemplateName	String	协议端口组名称 示例值：WEB服务端口协议组
ParamTemplateId	String	协议端口组ID 示例值：pp-1q2w3e4r
SourceName	String	访问源名称 示例值：内实例1
TargetName	String	访问目的名称 示例值：内部实例2
LastHitTime	String	规则最近命中时间 示例值：2024-10-24 00:00:00

DescNatDnatRule

NAT防火墙Dnat规则列表

被如下接口引用：DescribeNatFwDnatRule。

名称	类型	描述
Id	Integer	id 示例值：100
IpProtocol	String	网络协议，可选值：TCP、UDP。 示例值：TCP
PublicIpAddress	String	弹性IP。 示例值：175.27.187.125
PublicPort	Integer	公网端口。 示例值：80
PrivateIpAddress	String	内网地址。 示例值：10.10.1.1
PrivatePort	Integer	内网端口。 示例值：80
Description	String	NAT防火墙转发规则描述。 示例值：自定义描述
IsReferenced	Integer	是否被关联引用，如被远程运维使用 示例值：0
FwInsId	String	所属防火墙实例id 示例值：cfwnat-xxx
NatGwId	String	关联的nat网关Id 示例值：nat-xxx

DnsVpcSwitch

设置nat防火墙的vpc dns 接入开关

被如下接口引用：ModifyNatFwVpcDnsSwitch。

名称	类型	必选	描述
VpcId	String	是	vpc id 示例值：vpc-ilbrv877
Status	Integer	是	0：设置为关闭 1:设置为打开 示例值：1

EdgeIpInfo

边界防火墙公网IP开关列表

被如下接口引用：DescribeFwEdgeIps。

名称	类型	描述
PublicIp	String	公网IP 示例值：1.1.1.1
PublicIpType	Integer	公网 IP 类型 1 公网,2 弹性,3 弹性ipv6,4 anycastIP, 6 HighQualityEIP 示例值：2
InstanceId	String	实例ID 示例值：ins-abcdabdc
InstanceName	String	实例名 示例值：生产
IntranetIp	String	内网IP 示例值：192.168.1.1
AssetType	String	资产类型 示例值：CVM
Region	String	地域 示例值：ap-guangzhou
PortRiskCount	Integer	风险端口数 示例值：1
LastScanTime	String	最近扫描时间 示例值：2024-10-22 10:00:00
IsRegionEip	Integer	是否为region eip 0 不为region eip，不能选择串行 1 为region eip 可以选择串行 示例值：1
VpcId	String	EIP 所关联的VPC 示例值：vpc-wxecrvtb
IsSerialRegion	Integer	0: 该地域暂未支持串行 1: 该用户未在该地域配置串行带宽 2: 该用户已在该地域配置串行带宽，可以开启串行开关 示例值：1
IsPublicClb	Integer	0: 不是公网CLB 可以开启串行开关 1: 是公网CLB 不可以开启串行开关 示例值：0
EndpointBindEipNum	Integer	0: 开启开关时提示要创建私有连接。 1: 关闭该开关是提示删除私有连接。 如果大于 1: 关闭开关 、开启开关不需提示创建删除私有连接。 示例值：0
ScanMode	String	扫描深度 示例值：0
ScanStatus	Integer	扫描状态 示例值：0
Status	Integer	开关状态 0 : 关闭 1 : 开启 2 : 开启中 3 : 关闭中 4 : 异常 示例值：0
EndpointId	String	私有连接ID 示例值：vpce-wxecrvtb
EndpointIp	String	私有连接IP 示例值：10.10.10.10
SwitchMode	Integer	0 : 旁路 1 : 串行 2 : 正在模式切换 示例值：0
SwitchWeight	Integer	开关权重 示例值：1
Domain	String	域名化CLB的域名 示例值：www.***.com
OverUsedStatus	Integer	IP超量状态 示例值：0

EdgeIpSwitch

开启、关闭 防火墙互联网边界开关

被如下接口引用：ModifyEdgeIpSwitch。

名称	类型	必选	描述
PublicIp	String	是	公网IP 示例值：1.1.1.1
SubnetId	String	否	vpc 中第一个EIP开关打开，需要指定子网创建私有连接 示例值：subnet-xxxxxxxx
EndpointIp	String	否	创建私有连接指定IP 示例值：10.1.1.1
SwitchMode	Integer	否	0 : 旁路 1 : 串行 示例值：1

EnterpriseSecurityGroupRuleBetaInfo

企业安全组自动化任务信息

被如下接口引用：DescribeEnterpriseSecurityGroupRuleList。

名称	类型	必选	描述
TaskId	Integer	否	任务id 示例值：9001
TaskName	String	否	任务名称 示例值：autotest
LastTime	String	否	时间 示例值：1999-01-01 00:00:01

EnterpriseSecurityGroupRuleRuleInfo

企业安全组规则列表信息

被如下接口引用：DescribeEnterpriseSecurityGroupRuleList。

名称	类型	描述
OrderIndex	Integer	排序 示例值：1
RuleUuid	Integer	主键id 示例值：1
Uuid	String	规则uuid 示例值：sg-3c140219
SourceId	String	源规则内容 示例值：1.1.1.1
SourceType	Integer	源规则类型 取值范围 0/1/2/3/4/5/6/7/8/9/100 0表示ip(net), 1表示VPC实例(intance) 2表示子网实例(intance) 3表示CVM实例(intance) 4表示CLB实例(intance) 5表示ENI实例(intance) 6表示数据库实例(intance) 7表示模版(template) 8表示标签(tag) 9表示地域(region) 100表示资产分组(resourcegroup) 示例值：0
TargetId	String	目的规则内容 示例值：1.1.1.1
TargetType	Integer	目的规则类型 取值范围 0/1/2/3/4/5/6/7/8/9/100 0表示ip(net), 1表示VPC实例(intance) 2表示子网实例(intance) 3表示CVM实例(intance) 4表示CLB实例(intance) 5表示ENI实例(intance) 6表示数据库实例(intance) 7表示模版(template) 8表示标签(tag) 9表示地域(region) 100表示资产分组(resourcegroup) 示例值：0
Protocol	String	协议名称 取值范围:TCP/ANY/ICMP/UDP ANY:表示所有 示例值：TCP
Port	String	端口 示例值：3306
Strategy	Integer	规则策略 取值范围:1/2 1:阻断 2:放行 示例值：1
Status	Integer	规则启用状态 取值范围： 0/1 0:未开启 1:开启 示例值：1
Detail	String	描述 示例值：规则描述
AclTags	String	标签 示例值：tag
IsNew	Integer	规则最新一次是否有改动 取值范围：0/1 0:否 1:是 示例值：1
Region	String	地域 示例值：ap-guangzhou
IsDelay	Integer	是否延迟下发规则 取值范围：0/1 0:立即下发 1:延迟下发 示例值：0
ServiceTemplateId	String	服务模板id 示例值：tpm-3c140219
SouInstanceName	String	源资产名称 示例值：ins-3c140219
SouPublicIp	String	源资产公网ip 示例值：1.1.1.1
SouPrivateIp	String	源资产内网ip 示例值：1.1.1.1
SouCidr	String	源资产网段信息 示例值：10.0.0.0/32
SouParameterName	String	源模板名称 示例值：模板名称
InstanceName	String	目的资产名称 示例值：ins-3c140219
PublicIp	String	目的资产公网ip 示例值：1.1.1.1
PrivateIp	String	目的资产内网ip 示例值：1.1.1.1
Cidr	String	目的资产网段信息 示例值：10.0.0.0/32
ParameterName	String	目的模板名称 示例值：模板名称
ProtocolPortName	String	端口模板名称 示例值：模板名称
BetaList	Array of EnterpriseSecurityGroupRuleBetaInfo	自动化任务信息 示例值：[{"TaskId":"9001","TaskName":"autotest","LastTime":"1999-01-01 00:00:01"}]
Id	Integer	规则id 等同RuleUuid 示例值：1

FwCidrInfo

防火墙网段信息

被如下接口引用：CreateNatFwInstance, CreateNatFwInstanceWithDomain, CreateVpcFwGroup, ModifyNatFwReSelect, ModifyVpcFwGroup。

名称	类型	必选	描述
FwCidrType	String	是	防火墙使用的网段类型，值VpcSelf/Assis/Custom分别代表自有网段优先/扩展网段优先/自定义 示例值：VpcSelf
FwCidrLst	Array of FwVpcCidr	否	为每个vpc指定防火墙的网段 示例值：[{"VpcId":"vpc-39sc6ru5","FwCidr":"192.168.1.0/24"}]
ComFwCidr	String	否	其他防火墙占用网段，一般是防火墙需要独占vpc时指定的网段 示例值：172.10.0.0/24

FwDeploy

防火墙部署输入参数列表

被如下接口引用：CreateVpcFwGroup, ModifyVpcFwGroup。

名称	类型	必选	描述
DeployRegion	String	是	防火墙部署地域 示例值：ap-guangzhou
Width	Integer	是	带宽，单位：Mbps 示例值：500
CrossAZone	Integer	否	异地灾备 1：使用异地灾备；0：不使用异地灾备；为空则默认不使用异地灾备 示例值：0
Zone	String	否	主可用区，为空则选择默认可用区 示例值：ap-guangzhou-1
ZoneBak	String	否	备可用区，为空则选择默认可用区 示例值：ap-guangzhou-2
CdcId	String	否	若为cdc防火墙时填充该id 示例值：cluster-xxx

FwGateway

防火墙引流网关信息

被如下接口引用：DescribeFwGroupInstanceInfo。

名称	类型	必选	描述
GatewayId	String	是	防火墙网关id 示例值：havip-85becc
VpcId	String	是	网关所属vpc id 示例值：vpc-a59a64
IpAddress	String	是	网关ip地址 示例值：192.168.1.1/24

FwGroupSwitch

多种VPC墙模式开关结构

被如下接口引用：ModifyFwGroupSwitch。

名称	类型	必选	描述
SwitchMode	Integer	否	防火墙实例的开关模式 1: 单点互通 2: 多点互通 3: 全互通 4: 自定义路由 示例值：1
SwitchId	String	否	防火墙开关ID 支持三种类型 1. 边开关(单点互通) 2. 点开关(多点互通) 3. 全开关(全互通) 示例值：cfws-wxecrvtb

FwGroupSwitchShow

VPC防火墙(组)四种开关展示

被如下接口引用：DescribeVpcFwGroupSwitch。

名称	类型	描述
SwitchId	String	防火墙开关ID 示例值：cfws-wxecrvtb
SwitchName	String	防火墙开关NAME 示例值：vpc1-vpc2开关
SwitchMode	Integer	互通模式 示例值：1
ConnectType	Integer	开关边连接类型 0：对等连接， 1：云连网 示例值：1
ConnectId	String	连接ID 示例值：ccn-58cqznrf
ConnectName	String	连接名称 示例值：云联网ccn防火墙开发--勿删
SrcInstancesInfo	Array of NetInstancesInfo	源实例信息 示例值：[{"InstanceId":"vpc-dw314am3","InstanceName":"冲突sdwan","InstanceCidr":"10.24.0.0/16","Region":"ap-nanjing"}]
DstInstancesInfo	Array of NetInstancesInfo	目的实例信息 示例值：[{"InstanceId":"vpc-dw314am3","InstanceName":"冲突sdwan","InstanceCidr":"10.24.0.0/16","Region":"ap-nanjing"}]
FwGroupId	String	防火墙(组)数据 示例值：cfwg-wxecrvtb
FwGroupName	String	防火墙(组)名称 示例值：生产防火墙组
Enable	Integer	开关状态 0：关 ， 1：开 示例值：1
Status	Integer	开关的状态 0：正常， 1：转换中 示例值：0
AttachWithEdge	Integer	0-非sase实例，忽略，1-未绑定状态，2-已绑定 示例值：0
CrossEdgeStatus	Integer	对等防火墙和开关状态 0：正常， 1：对等未创建防火墙，2：对等已创建防火墙，未打开开关 示例值：0
FwInsRegion	Array of String	网络经过VPC防火墙CVM所在地域 示例值：ap-chongqing
IpsAction	Integer	0 观察 1 拦截 2 严格 3 关闭 4 不支持ips 前端展示tag 示例值：1
FwInsLst	Array of VpcFwInstanceShow	开关关联的防火墙实例列表 示例值：[{"FwInsId":"cfwew-63a110d9","FwInsName":"云连网leo测试-南京","FwInsRegion":"ap-nanjing"}]
BypassStatus	Integer	开关是否处于bypass状态 0：正常状态 1：bypass状态 示例值：1
IpVersion	Integer	0: ipv4 , 1:ipv6 示例值：1

FwVpcCidr

vpc的防火墙网段

被如下接口引用：CreateNatFwInstance, CreateNatFwInstanceWithDomain, CreateVpcFwGroup, ModifyNatFwReSelect, ModifyVpcFwGroup。

名称	类型	必选	描述
VpcId	String	是	vpc的id 示例值：vpc-xxx1
FwCidr	String	是	防火墙网段，最少/24的网段 示例值：192.168.0.0/24

IPDefendStatus

ip防护状态

被如下接口引用：DescribeIPStatusList。

名称	类型	描述
IP	String	ip地址 示例值：1.2.3.4
Status	Integer	防护状态 1:防护打开; -1:地址错误; 其他:未防护 示例值：1

IdsWhiteInfo

入侵防御规则白名单详情

被如下接口引用：DescribeIdsWhiteRule。

名称	类型	描述
Id	Integer	白名单唯一ID 示例值：50
SrcIp	String	源IP 示例值：10.23.22.1
DstIp	String	目的IP 示例值：10.23.22.2
WhiteRuleType	String	规则类型 示例值：srddst
FwType	Integer	白名单生效防火墙范围： 1 边界防火墙 2 nat防火墙 4 vpc防火墙 7 = 1+2+4 所有防火墙 示例值：7
RuleId	String	入侵防御规则ID 示例值：20016

InstanceInfo

实例详情结果

被如下接口引用：DescribeSourceAsset。

名称	类型	描述
AppId	String	appid信息 示例值：1300448058
InsSource	String	资产来源 1公网 2内网 示例值：1
InsType	Integer	资产类型 3是cvm实例,4是clb实例,5是eni实例,6是mysql,7是redis,8是NAT,9是VPN,10是ES,11是MARIADB,12是KAFKA 13 NATFW 示例值：6
InstanceId	String	资产id 示例值：ins-888
InstanceName	String	资产名 示例值：cfwinfo
LeakNum	String	漏洞数 示例值：0
PortNum	String	端口数 示例值：1
PrivateIp	String	内网ip 示例值：172.11.85.5
PublicIp	String	公网ip 示例值：120.11.85.5,211.10,2.,5
Region	String	地域 示例值：上海
RegionKey	String	地域 示例值：上海
ResourcePath	Array of String	资产路径 示例值：[path1,path2]
Server	Array of String	扫描结果 示例值：["dns"]
SubnetId	String	子网id 示例值：sub-1ftesgd1
VPCName	String	vpc名称 示例值：vpcname-1
VpcId	String	vpcid信息 示例值：vpc-rcd55477

IntrusionDefenseRule

入侵防御封禁列表、放通列表添加规则入参

被如下接口引用：CreateBlockIgnoreRuleList, ModifyBlockIgnoreRule。

名称	类型	必选	描述
Direction	Integer	是	规则方向，0出站，1入站，3内网间 示例值：1
EndTime	String	是	规则结束时间，格式：2006-01-02 15:04:05，必须大于当前时间 示例值：2021-09-21 12:00:00
IP	String	否	规则IP地址，IP与Domain必填其中之一 示例值：1.1.1.1
Domain	String	否	规则域名，IP与Domain必填其中之一 示例值：www.test.com
StartTime	String	否	规则开始时间 示例值：2021-09-21 12:00:00
Comment	String	否	备注信息，长度不能超过50 示例值：放通ip

IocListData

封禁放通IOC列表

被如下接口引用：CreateBlockIgnoreRuleList, DeleteBlockIgnoreRuleList, ModifyBlockIgnoreList。

名称	类型	必选	描述
IP	String	是	待处置IP地址，IP/Domain字段二选一 示例值：192.168.1.1
Direction	Integer	是	只能为0或者1 0代表出站 1代表入站 示例值：1
Domain	String	否	待处置域名，IP/Domain字段二选一 示例值：www.qq.com

IpStatic

统计折线图通用结构体

被如下接口引用：DescribeBlockByIpTimesList。

名称	类型	描述
Num	Integer	值 示例值：10
StatTime	String	折线图横坐标时间 示例值：2021-05-21

NatFwEipsInfo

Nat防火墙弹性公网ip列表

被如下接口引用：DescribeCfwEips。

名称	类型	描述
Eip	String	弹性公网ip 示例值：175.27.187.125
NatGatewayId	String	所属的Nat网关Id 示例值：nat-7cq345j4
NatGatewayName	String	Nat网关名称 示例值：testName

NatFwFilter

nat fw 实例展示的过滤列表

被如下接口引用：DescribeNatFwInstancesInfo。

名称	类型	必选	描述
FilterType	String	是	过滤的类型，例如实例id 示例值：NatinsId
FilterContent	String	是	过滤的内容，以',' 分隔 示例值：cfwnat-65d0d823,cfwnat-65d0d823

NatFwInstance

Nat实例类型

被如下接口引用：DescribeNatFwInstance, DescribeNatFwInstanceWithRegion。

名称	类型	描述
NatinsId	String	nat实例id 示例值：cfwnat-4fb07125
NatinsName	String	nat实例名称 示例值：实例1
Region	String	实例所在地域 示例值：ap-shanghai
FwMode	Integer	0:新增模式，1:接入模式 示例值：0
Status	Integer	0:正常状态， 1: 正在创建 示例值：0
NatIp	String	nat公网ip 示例值：1.1.1.1,2.2.2.2

NatInstanceInfo

Nat实例卡片详细信息

被如下接口引用：DescribeNatFwInstancesInfo。

名称	类型	描述
NatinsId	String	nat实例id 示例值：cfwnat-4fb07125
NatinsName	String	nat实例名称 示例值：实例1
Region	String	实例所在地域 示例值：ap-shanghai
FwMode	Integer	0: 新增模式，1:接入模式 示例值：0
BandWidth	Integer	实例带宽大小 Mbps 示例值：20
InFlowMax	Integer	入向带宽峰值 bps 示例值：200
OutFlowMax	Integer	出向带宽峰值 bps 示例值：231
RegionZh	String	地域中文信息 示例值：广州
EipAddress	Array of String	公网ip数组 示例值：["106.55.4.81"]
VpcIp	Array of String	内外使用ip数组 示例值：["10.255.1.20"]
Subnets	Array of String	实例关联子网数组 示例值：["subnet-0fl56e31"]
Status	Integer	0 :正常 1：正在初始化 示例值：0
RegionDetail	String	地域区域信息 示例值：华南地区
ZoneZh	String	实例所在可用区 示例值：广州六区
ZoneZhBak	String	实例所在可用区 示例值：广州七区
RuleUsed	Integer	已使用规则数 示例值：100
RuleMax	Integer	实例的规则限制最大规格数 示例值：5000
EngineVersion	String	实例引擎版本 示例值：cfw_3.7.0.888
UpdateEnable	Integer	引擎是否可升级：0，不可升级；1，可升级 示例值：0
NeedProbeEngineUpdate	Integer	是的需要升级引擎 支持 nat拨测 1需要 0不需要 示例值：1
TrafficMode	String	引擎运行模式，Normal:正常, OnlyRoute:透明模式 示例值：Normal
Zone	String	实例主所在可用区 示例值：ap-guangzhou-6
ZoneBak	String	实例备所在可用区 示例值：ap-guangzhou-7
ReserveTime	String	引擎预约升级时间 示例值：2021-12-09 11:56:58
ReserveVersion	String	引擎预约升级版本 示例值：cfw_3.8.0.888
ReserveVersionState	String	引擎预约升级版本状态 stable:稳定版；previewed:预览版 示例值：stable
ElasticSwitch	Integer	弹性开关 1 打开 0 关闭 示例值：0
ElasticBandwidth	Integer	弹性带宽，单位Mbps 示例值：100
IsFirstAfterPay	Integer	是否首次开通按量付费 1 是 0 不是 示例值：1

NetInstancesInfo

网络实例信息

被如下接口引用：DescribeVpcFwGroupSwitch。

名称	类型	描述
InstanceId	String	网络实例ID 示例值：vpc-xxxxxxxx
InstanceName	String	网络实例名称 示例值：chengdu-云联网CCN-VPC2-勿用
InstanceCidr	String	网络cidr (多段以逗号分隔) 示例值：10.1.0.0/16
Region	String	网络实例所在地域 示例值：ap-guangzhou

NewModeItems

新增模式传递参数

被如下接口引用：CreateNatFwInstance, CreateNatFwInstanceWithDomain。

名称	类型	必选	描述
VpcList	Array of String	是	新增模式下接入的vpc列表 示例值：["vpc-q98tz7hs","vpc-x98tz7ha"]
Eips	Array of String	否	新增模式下绑定的出口弹性公网ip列表，其中Eips和AddCount至少传递一个。 示例值：["175.27.187.125"]
AddCount	Integer	否	新增模式下新增绑定的出口弹性公网ip个数，其中Eips和AddCount至少传递一个。 示例值：1

RuleChangeItem

规则顺序变更项，由原始id值变为新的id值。

被如下接口引用：ModifyNatSequenceRules, ModifySequenceAclRules, ModifyVpcFwSequenceRules。

名称	类型	必选	描述
OrderIndex	Integer	是	原始sequence 值 示例值：100
NewOrderIndex	Integer	是	新的sequence 值 示例值：101
IpVersion	Integer	否	Ip版本，0：IPv4，1：IPv6，默认为IPv4 示例值：0

RuleInfoData

规则输入对象

被如下接口引用：CreateAcRules, ModifyAcRule。

名称	类型	必选	描述
OrderIndex	Integer	是	执行顺序 示例值：1
SourceIp	String	是	访问源 示例值：0.0.0.0
TargetIp	String	是	访问目的 示例值：1.1.1.1
Protocol	String	是	协议 示例值：HTTP
Strategy	String	是	策略, 0：观察，1：阻断，2：放行 示例值：0
SourceType	Integer	是	访问源类型，1是IP，3是域名，4是IP地址模板，5是域名地址模板 示例值：1
Direction	Integer	是	方向，0：出站，1：入站 示例值：0
Detail	String	是	描述 示例值：andy创建的规则
TargetType	Integer	是	访问目的类型，1是IP，3是域名，4是IP地址模板，5是域名地址模板 示例值：1
Port	String	否	端口 示例值：80
Id	Integer	否	id值 示例值：1
LogId	String	否	日志id，从告警处创建必传，其它为空 示例值：kYtiGTORZGin
City	Integer	否	城市Code 示例值：1
Country	Integer	否	国家Code 示例值：1
CloudCode	String	否	云厂商，支持多个，以逗号分隔， 1:腾讯云（仅中国香港及海外）,2:阿里云,3:亚马逊云,4:华为云,5:微软云 示例值：1
IsRegion	Integer	否	是否为地域 示例值：1
CityName	String	否	城市名 示例值：广州
CountryName	String	否	国家名 示例值：中国
RegionIso	String	否	国家二位iso代码或者省份缩写代码 示例值：cn

ScanInfo

新手引导扫描信息

被如下接口引用：DescribeGuideScanInfo。

名称	类型	描述
ScanPercent	Float	进度 示例值：0.55
ScanResultInfo	ScanResultInfo	扫描结果信息 示例值：{"BanStatus":true,"IPNum":34,"IPStatus":true,"IdpStatus":true,"LeakNum":209,"PortNum":0}
ScanStatus	Integer	扫描状态 0扫描中 1完成 2未勾选自动扫描 示例值：1
ScanTime	String	预计完成时间 示例值：2021-04-17 12:20:03

ScanResultInfo

新手引导扫描结果信息

被如下接口引用：DescribeGuideScanInfo。

名称	类型	描述
BanStatus	Boolean	是否禁封端口 示例值：true
IPNum	Integer	防护ip数量 示例值：10
IPStatus	Boolean	是否开启防护 示例值：true
IdpStatus	Boolean	是否拦截攻击 示例值：true
LeakNum	Integer	暴露漏洞数量 示例值：5
PortNum	Integer	暴露端口数量 示例值：10

SecurityGroupBothWayInfo

双向下发的企业安全组规则

被如下接口引用：CreateSecurityGroupRules, DescribeSecurityGroupList, ModifySecurityGroupRule。

名称	类型	必选	描述
OrderIndex	Integer	是	执行顺序 示例值：1
SourceId	String	是	访问源 示例值：1.1.1.1
SourceType	Integer	是	访问源类型，默认为0，0: IP, 1: VPC, 2: SUBNET, 3: CVM, 4: CLB, 5: ENI, 6: CDB, 7: 参数模板, 100: 资产分组 示例值：7
TargetId	String	是	访问目的 示例值：1.1.1.1
TargetType	Integer	是	访问目的类型，默认为0，0: IP, 1: VPC, 2: SUBNET, 3: CVM, 4: CLB, 5: ENI, 6: CDB, 7: 参数模板, 100: 资产分组 示例值：2
Protocol	String	是	协议 示例值：ANY
Port	String	是	目的端口 示例值：-1/-1
Strategy	Integer	是	策略, 1：阻断，2：放行 示例值：2
Direction	Integer	是	方向，0：出站，1：入站，默认1 示例值：1
Region	String	是	地域 示例值：ap-guangzhou
Detail	String	否	描述 示例值：andy的规则
Status	Integer	否	是否开关开启，0：未开启，1：开启 示例值：1
IsNew	Integer	否	是否是正常规则，0：正常，1：异常 示例值：1
BothWay	Integer	否	单/双向下发，0:单向下发，1：双向下发 示例值：0
VpcId	String	否	私有网络ID 示例值：vpc-iedpwx01d
SubnetId	String	否	子网ID 示例值：subnet-ed2witec
InstanceName	String	否	实例名称 示例值：andy的cvm
PublicIp	String	否	公网IP，多个以英文逗号分隔 示例值：1.1.1.1
PrivateIp	String	否	内网IP，多个以英文逗号分隔 示例值：1.1.1.1
Cidr	String	否	掩码地址，多个以英文逗号分隔 示例值：10.72.1.0/24
ServiceTemplateId	String	否	端口协议类型参数模板id 示例值：pp-peodxd0e
ProtocolPortType	Integer	否	是否使用端口协议模板，0：否，1：是 示例值：1

SecurityGroupListData

安全组列表数据

被如下接口引用：CreateSecurityGroupRules, DescribeSecurityGroupList, ModifySecurityGroupRule。

名称	类型	必选	描述
OrderIndex	Integer	是	执行顺序 示例值：1
SourceId	String	是	访问源 示例值：ipm-dyodhpby
SourceType	Integer	是	访问源类型，默认为0，1: VPC, 2: SUBNET, 3: CVM, 4: CLB, 5: ENI, 6: CDB, 7: 参数模板, 100: 资源组 示例值：7
TargetId	String	是	访问目的 示例值：subnet-fmo10koi
TargetType	Integer	是	访问目的类型，默认为0，1: VPC, 2: SUBNET, 3: CVM, 4: CLB, 5: ENI, 6: CDB, 7: 参数模板, 100:资源组 示例值：2
Protocol	String	是	协议 示例值：ANY
Port	String	是	目的端口 示例值：-1/-1
Strategy	Integer	是	策略, 1：阻断，2：放行 示例值：2
Detail	String	是	描述 示例值：andy的规则
BothWay	Integer	是	单/双向下发，0:单向下发，1：双向下发 示例值：0
Id	Integer	否	规则ID 示例值：1
Status	Integer	否	是否开关开启，0：未开启，1：开启 示例值：1
IsNew	Integer	否	是否是正常规则，0：正常，1：异常 示例值：1
VpcId	String	否	私有网络ID 示例值：vpc-8xuf8kf5
SubnetId	String	否	子网ID 示例值：subnet-fmo10koi
InstanceName	String	否	实例名称 示例值：InstanceName
PublicIp	String	否	公网IP，多个以英文逗号分隔 示例值：1.1.1.1
PrivateIp	String	否	内网IP，多个以英文逗号分隔 示例值：9.0.0.1
Cidr	String	否	掩码地址，多个以英文逗号分隔 示例值：9.0.0.1/32
ServiceTemplateId	String	否	端口协议类型参数模板id 示例值：ppmg-jz17vpis
BothWayInfo	Array of SecurityGroupBothWayInfo	否	生成双向下发规则 示例值：[{"OrderIndex":1,"SourceId":"1.1.1.1","SourceType":7,"TargetId":"1.1.1.1","TargetType":2,"Protocol":"ANY","Port":"-1/-1","Strategy":2,"Detail":"andy的规则","Status":1,"IsNew":1,"BothWay":0,"VpcId":"vpc-iedpwx01d","SubnetId":"subnet-ed2witec","InstanceName":"andy的cvm","PublicIp":"1.1.1.1","PrivateIp":"1.1.1.1","Cidr":"10.72.1.0/24","ServiceTemplateId":"pp-peodxd0e","Direction":1,"Region":"ap-guangzhou","ProtocolPortType":1}]
Direction	Integer	否	方向，0：出站，1：入站，默认1 示例值：0
ProtocolPortType	Integer	否	是否使用端口协议模板，0：否，1：是 示例值：1
Uuid	String	否	Uuid 示例值：cfw_sg_appid_0.0.0.0/0_17295140975391
Region	String	否	地域 示例值：ap-guangzhou
AssetGroupNameIn	String	否	资产分组名称 示例值：/全部资产/
AssetGroupNameOut	String	否	资产分组名称 示例值：/全部资产/
ParameterName	String	否	模板名称 示例值：自动化勿删IP组模板
ProtocolPortName	String	否	端口协议类型参数模板名称 示例值：端口协议类型参数模板名称

SecurityGroupOrderIndexData

企业安全组规则执行顺序修改对象

被如下接口引用：ModifySecurityGroupSequenceRules。

名称	类型	必选	描述
OrderIndex	Integer	是	企业安全组规则当前执行顺序 示例值：3
NewOrderIndex	Integer	是	企业安全组规则更新目标执行顺序 示例值：1

SecurityGroupRule

安全组规则

被如下接口引用：AddEnterpriseSecurityGroupRules, DescribeEnterpriseSecurityGroupRule, ModifyEnterpriseSecurityGroupRule。

名称	类型	必选	描述
SourceContent	String	是	访问源示例： net：IP/CIDR(192.168.0.2) template：参数模板id(ipm-dyodhpby) instance：资产实例id(ins-123456) resourcegroup：资产分组id(cfwrg-xxxx) tag：资源标签({"Key":"标签key值","Value":"标签Value值"}) region：地域(ap-gaungzhou) 示例值：ipm-dyodhpby
SourceType	String	是	访问源类型，类型可以为以下6种：net|template|instance|resourcegroup|tag|region 示例值：template
DestContent	String	是	访问目的示例： net：IP/CIDR(192.168.0.2) template：参数模板id(ipm-dyodhpby) instance：资产实例id(ins-123456) resourcegroup：资产分组id(cfwrg-xxxx) tag：资源标签({"Key":"标签key值","Value":"标签Value值"}) region：地域(ap-gaungzhou) 示例值：ins-fmo10koi
DestType	String	是	访问目的类型，类型可以为以下6种：net|template|instance|resourcegroup|tag|region 示例值：instance
RuleAction	String	是	访问控制策略中设置的流量通过云防火墙的方式。取值： accept：放行 drop：拒绝 示例值：accept
Description	String	是	描述 示例值：andy创建的规则
OrderIndex	String	是	规则顺序，-1表示最低，1表示最高，请勿和外层Type冲突（和外层的Type配合使用，当中间插入时，指定添加位置） 示例值：-1
Protocol	String	否	协议；TCP/UDP/ICMP/ANY 示例值：ANY
Port	String	否	访问控制策略的端口。取值： -1/-1：全部端口 80：80端口 示例值：-1/-1
ServiceTemplateId	String	否	端口协议类型参数模板id；协议端口模板id；与Protocol,Port互斥 示例值：ppmg-jz17vpis
Id	String	否	（入参时无需填写，自动生成）规则对应的唯一id 示例值：8888
Enable	String	否	（入参时、Enable已弃用；由通用配置中新增规则启用状态控制） 规则状态，true表示启用，false表示禁用 示例值：true
Uid	String	否	规则对应的唯一内部id 示例值：1

SecurityGroupSimplifyRule

安全组规则

被如下接口引用：AddEnterpriseSecurityGroupRules。

名称	类型	描述
SourceContent	String	访问源示例： net：IP/CIDR(192.168.0.2) template：参数模板(ipm-dyodhpby) instance：资产实例(ins-123456) resourcegroup：资产分组(/全部分组/分组1/子分组1) tag：资源标签({"Key":"标签key值","Value":"标签Value值"}) region：地域(ap-gaungzhou) 示例值：ipm-dyodhpby
DestContent	String	访问目的示例： net：IP/CIDR(192.168.0.2) template：参数模板(ipm-dyodhpby) instance：资产实例(ins-123456) resourcegroup：资产分组(/全部分组/分组1/子分组1) tag：资源标签({"Key":"标签key值","Value":"标签Value值"}) region：地域(ap-gaungzhou) 示例值：ins-fmo10koi
Protocol	String	协议；TCP/UDP/ICMP/ANY 示例值：ANY
Description	String	描述 示例值：规则描述
RuleUuid	Integer	规则对应的唯一id 示例值：8888
Sequence	Integer	规则序号 示例值：1

SequenceData

执行顺序对象

被如下接口引用：ModifySequenceRules。

名称	类型	必选	描述
Id	Integer	是	规则Id值 示例值：9851
OrderIndex	Integer	是	修改前执行顺序 示例值：21
NewOrderIndex	Integer	是	修改后执行顺序 示例值：22

StaticInfo

StaticInfo 告警柱形图统计信息

被如下接口引用：DescribeBlockStaticList, DescribeTLogIpList。

名称	类型	描述
Address	String	地址 示例值：上海
InsID	String	资产id 示例值：ins-123456
InsName	String	资产名称 示例值：ins-机器
Ip	String	ip信息 示例值：“183.45.1.2"
Num	Integer	数 示例值：10
Port	String	端口 示例值：80

SwitchListsData

防火墙开关列表对象

被如下接口引用：DescribeSwitchLists。

名称	类型	描述
PublicIp	String	公网IP 示例值：1.14.67.183
IntranetIp	String	内网IP 示例值：10.26.26.11,10.26.26.15,10.26.26.30,10.26.26.31,10.26.26.32,10.26.26.33,10.26.26.34,10.26.26.35,10.26.26.36,10.26.26.37
InstanceName	String	实例名 示例值：nta-服务端性能
InstanceId	String	实例ID 示例值：ins-fdysvd0j
AssetType	String	资产类型 示例值：CVM
Area	String	地域 示例值：成都
Switch	Integer	防火墙开关 示例值：0
Id	Integer	id值 示例值：6414090
PublicIpType	Integer	公网 IP 类型 示例值：2
PortTimes	Integer	风险端口数 示例值：0
LastTime	String	最近扫描时间 示例值：2024-03-08 14:56:54
ScanMode	String	扫描深度 示例值：light
ScanStatus	Integer	扫描状态 示例值：0

TLogInfo

告警中心概览数据

被如下接口引用：DescribeTLogInfo。

名称	类型	描述
BanNum	Integer	封禁列表 示例值：126
BruteForceNum	Integer	暴力破解 示例值：221
HandleNum	Integer	待处置告警 示例值：221
NetworkNum	Integer	网络探测 示例值：1
OutNum	Integer	失陷主机 示例值：10
VulNum	Integer	漏洞攻击 示例值：0

TagInfo

标签信息

被如下接口引用：ExpandCfwVertical。

名称	类型	必选	描述
TagKey	String	否	目标key 示例值：key
TagValue	String	否	目标值 示例值：value

TemplateListInfo

地址模板列表数据

被如下接口引用：DescribeAddressTemplateList。

名称	类型	描述
Uuid	String	模板ID 示例值：mb_1300448058_1636944838448
Name	String	模板名称 示例值：出向白名单
Detail	String	描述 示例值：放通出方向目的ip
IpString	String	IP模板 示例值：1.1.1.1
InsertTime	String	插入时间 示例值：2021-11-15 10:53:58
UpdateTime	String	修改时间 示例值：2021-11-15 10:53:58
Type	Integer	模板类型 示例值：1
RulesNum	Integer	关联规则条数 示例值：1
TemplateId	String	模板Id 示例值：pp-test
ProtocolType	String	协议端口模板，协议类型，4:4层协议，7:7层协议 示例值：4
IPNum	Integer	模板包含地址数量 示例值：1
IpVersion	Integer	IP版本,0,IPv4;1,IPv6 示例值：0

UnHandleEvent

未处置事件详情

被如下接口引用：DescribeUnHandleEventTabList。

名称	类型	描述
EventTableListStruct	Array of UnHandleEventDetail	伪攻击链类型 示例值：漏洞利用
BaseLineUser	Integer	1 是 0否 示例值：1
BaseLineInSwitch	Integer	1 打开 0 关闭 示例值：1
BaseLineOutSwitch	Integer	1 打开 0 关闭 示例值：1
VpcFwCount	Integer	vpc间防火墙实例数量 示例值：1

UnHandleEventDetail

未处置事件信息汇总

被如下接口引用：DescribeUnHandleEventTabList。

名称	类型	描述
EventName	String	安全事件名称 示例值：主机失陷
Total	Integer	未处置事件数量 示例值：100

VpcDnsInfo

nat防火墙 vpc dns 开关信息

被如下接口引用：DescribeNatFwVpcDnsLst。

名称	类型	描述
VpcId	String	vpc id 示例值：vpc-ilbrv877
VpcName	String	vpc 名称 示例值：运维
FwMode	Integer	nat 防火墙模式 0：新增模式， 1: 接入模式 示例值：0
VpcIpv4Cidr	String	vpc ipv4网段范围 CIDR（Classless Inter-Domain Routing，无类域间路由选择） 示例值：10.115.0.0/16
DNSEip	String	外网弹性ip，防火墙 dns解析地址 示例值：1.1.1.1
NatInsId	String	nat网关id 示例值：nat-2irqlrfj
NatInsName	String	nat网关名称 示例值：对外nat网关
SwitchStatus	Integer	0：开关关闭 ， 1: 开关打开 示例值：1
ProtectedStatus	Integer	0：未防护， 1: 已防护，2：忽略此字段 示例值：1
SupportDNSFW	Integer	是否支持DNS FW，0-不支持、1-支持 示例值：1

VpcFwCvmInsInfo

VPC防火墙实例的CVM信息

被如下接口引用：DescribeFwGroupInstanceInfo。

名称	类型	必选	描述
FwInsId	String	是	VPC防火墙实例ID 示例值：cfwew-af7aa5a3
Region	String	否	CVM所在地域 示例值：ap-chengdu
RegionZh	String	否	CVM所在地域中文 示例值：成都
RegionDetail	String	否	CVM所在地域详情 示例值：西南地区
ZoneZh	String	否	主机所在可用区 示例值：成都一区
ZoneZhBack	String	否	备机所在可用区 示例值：成都二区
BandWidth	Integer	否	防火墙CVM带宽值 示例值：1024
Zone	String	否	实例主机所在可用区 示例值：ap-chengdu-1
ZoneBak	String	否	实例备机所在可用区 示例值：ap-chengdu-2

VpcFwGroupInfo

VPC防火墙(组)及防火墙实例详情信息

被如下接口引用：DescribeFwGroupInstanceInfo。

名称	类型	描述
FwGroupId	String	防火墙(组)ID 示例值：cfwg-xxxxxxxx
FwGroupName	String	防火墙(组)名称 示例值：生产区防火墙
FwSwitchNum	Integer	防火墙组涉及到的开关个数 示例值：10
RegionLst	Array of String	防火墙(组)部署的地域 示例值：['ap-guangzhou']
Mode	Integer	模式 1：CCN云联网模式；0：私有网络模式 2: sase 模式 3：ccn 高级模式 4: 私有网络(跨租户单边模式) 示例值：1
SwitchMode	Integer	防火墙实例的开关模式 1: 单点互通 2: 多点互通 3: 全互通 4: 自定义路由 示例值：1
FwInstanceLst	Array of VpcFwInstanceInfo	VPC防火墙实例卡片信息数组 示例值：[ { "FwGroupId": "cfwg-48b0ce59", "FwInsName": "[autotest]【勿动】自动化测试-上海", "FwInsId": "cfwew-091fafd3", "FwMode": 1, "CcnId": [ "ccn-2stwf6cr" ], "CcnName": [ "[autotest][勿删]自动化测试" ], "PeerConnectionId": null, "PeerConnectionName": null, "FwCvmLst": [ { "FwInsId": "cfwew-091fafd3", "Region": "ap-shanghai", "RegionZh": "上海", "RegionDetail": "华东地区", "ZoneZh": "上海二区", "ZoneZhBack": "上海二区", "BandWidth": 1024 } ], "JoinInsLst": [ { "JoinType": "VPC", "Num": 2 } ], "JoinInsIdLst": [ "vpc-msa9dvac", "vpc-q9h93ip4" ], "FwGateway": [ { "GatewayId": "havip-0zv7jxun", "VpcId": "vpc-eo9n3mq2", "IpAddress": "10.183.0.4" } ], "JoinInsNum": 2, "FwSwitchNum": 1, "Status": 0, "Time": "2023-09-07 12:55:14", "Width": 1024, "UserVpcWidth": 11264, "RuleUsed": 56, "RuleMax": 20000, "FlowMax": 29322, "EngineVersion": "cfw_v4.0.2.1050", "UpdateEnable": 1, "TrafficMode": "Normal" } ]
Status	Integer	防火墙(状态) 0：正常 1: 初始化或操作中 示例值：0
FwVpcCidr	String	auto :自动选择 如果为网段，则为用户自定义 192.168.0.0/20 示例值：auto
CdcId	String	cdc专用集群场景时表示部署所属的cdc 示例值：cluster-wxecrvtb
CdcName	String	cdc专用集群场景时表示cdc名称 示例值：guangzhou-cdc
CrossUserMode	String	跨租户模式 1管理员 2单边 0 非跨租户 示例值：1
NeedSwitchCcnOverlap	Integer	云联网模式下，当前实例是否需要开启重叠路由开关，1：需要开启，0：不需要开启 示例值：0
CcnId	String	云联网模式下，实例关联的云联网id 示例值：ccn-wxecrvtb

VpcFwInstance

vpc 防火墙下单防火墙实例结构体

被如下接口引用：CreateVpcFwGroup, ModifyVpcFwGroup。

名称	类型	必选	描述
Name	String	是	防火墙实例名称 示例值：内网防火墙实例
VpcIds	Array of String	是	私有网络模式下接入的VpcId列表；仅私有网络模式使用 示例值：["vpc-xxx","vpc-xxx"]
FwDeploy	FwDeploy	是	部署地域信息 示例值：{"DeployRegion":"ap-guangzhou","Width":1024,"CrossAZone":1,"Zone":"ap-guangzhou-1","ZoneBak":"ap-guangzhou-2","CdcId":""}
FwInsId	String	否	防火墙实例ID (编辑场景传) 示例值：cfwew-xxxxxxxx

VpcFwInstanceInfo

VPC防火墙实例卡片信息

被如下接口引用：DescribeFwGroupInstanceInfo。

名称	类型	必选	描述
FwInsName	String	是	VPC防火墙实例名称 示例值：防火墙名称
FwInsId	String	是	VPC防火墙实例ID 示例值：cfwew-de1a3a1a
FwMode	Integer	是	VPC防火墙实例模式 0: 旧VPC模式防火墙 1: CCN模式防火墙 示例值：1
JoinInsNum	Integer	是	VPC防火墙接入网络实例个数 示例值：8
FwSwitchNum	Integer	是	VPC防火墙开关个数 示例值：8
Status	Integer	是	VPC防火墙状态 0:正常 ， 1：创建中 2: 变更中 示例值：0
Time	String	是	VPC防火墙创建时间 示例值：2021-12-09 11:56:58
CcnId	Array of String	否	VPC 相关云联网ID列表 示例值：["ccn-58cqznrf"]
CcnName	Array of String	否	VPC 相关云联网名称列表 示例值：["云联网ccn防火墙开发--勿删"]
PeerConnectionId	Array of String	否	VPC 相关对等连接ID列表 示例值：["pcx-985becc"]
PeerConnectionName	Array of String	否	VPC 相关对等连接名称列表 示例值：["跨vpc连接"]
FwCvmLst	Array of VpcFwCvmInsInfo	否	VPC防火墙CVM的列表 示例值：[{"FwInsId":"cfwew-75066e5a","Region":"ap-chongqing","RegionZh":"重庆","RegionDetail":"西南地区","ZoneZh":"重庆一区","ZoneZhBack":"重庆一区","BandWidth":50},{"FwInsId":"cfwew-75066e5a","Region":"ap-chengdu","RegionZh":"成都","RegionDetail":"西南地区","ZoneZh":"成都一区","ZoneZhBack":"成都一区","BandWidth":50}]
JoinInsLst	Array of VpcFwJoinInstanceType	否	VPC防火墙接入网络实例类型列表 示例值：[{"JoinType":"VPC","Num":5},{"JoinType":"DIRECTCONNECT","Num":1},{"JoinType":"VPNGW","Num":1}]
FwGateway	Array of FwGateway	否	防火墙网关信息 示例值：[{"GatewayId":"havip-0zv7jxun","VpcId":"vpc-eo9n3mq2","IpAddress":"10.183.0.4"}]
FwGroupId	String	否	防火墙(组)ID 示例值：cfwg-8f4cd56c
RuleUsed	Integer	否	已使用规则数 示例值：10
RuleMax	Integer	否	最大规则数 示例值：5000
Width	Integer	否	防火墙实例带宽 示例值：1024
UserVpcWidth	Integer	否	用户VPC墙总带宽 示例值：5000
JoinInsIdLst	Array of String	否	接入的vpc列表 示例值：["vpc-abcdabcd"]
FlowMax	Integer	否	内网间峰值带宽 (单位 bps ) 示例值：1000
EngineVersion	String	否	实例引擎版本 示例值：cfw_3.7.0.888
UpdateEnable	Integer	否	引擎是否可升级：0，不可升级；1，可升级 示例值：0
TrafficMode	String	否	引擎运行模式，Normal:正常, OnlyRoute:透明模式 示例值：Normal
ReserveTime	String	否	引擎预约升级时间 示例值：2021-12-09 11:56:58
ReserveVersion	String	否	预约引擎升级版本 示例值：cfw_3.8.0.888
ReserveVersionState	String	否	引擎预约升级版本状态 示例值：stable
ElasticSwitch	Integer	否	弹性开关 1打开 0关闭 示例值：1
ElasticBandwidth	Integer	否	弹性带宽，单位Mbps 示例值：100
IsFirstAfterPay	Integer	否	是否首次开通按量付费 1 是 0 不是 示例值：1

VpcFwInstanceShow

VPC防火墙实例信息

被如下接口引用：DescribeVpcFwGroupSwitch。

名称	类型	描述
FwInsId	String	VPC防火墙实例ID 示例值：cfwew-af7aa5a3
FwInsName	String	VPC防火墙实例名称 示例值：防火墙测试-实例1
FwInsRegion	String	网络经过VPC防火墙CVM所在地域 示例值：ap-chongqing

VpcFwJoinInstanceType

VPC防火墙接入的网络实例类型及数量

被如下接口引用：DescribeFwGroupInstanceInfo。

名称	类型	必选	描述
JoinType	String	是	接入实例类型，VPC、DIRECTCONNECT、 VPNGW 等 示例值：VPC
Num	Integer	是	接入的对应网络实例类型的数量 示例值：6

VpcRuleItem

VPC内网间规则

被如下接口引用：AddVpcAcRule, DescribeVpcAcRule, ModifyVpcAcRule。

名称	类型	必选	描述
SourceContent	String	是	访问源示例： net：IP/CIDR(192.168.0.2) 示例值：192.168.0.2
SourceType	String	是	访问源类型，类型可以为：net 示例值：net
DestContent	String	是	访问目的示例： net：IP/CIDR(192.168.0.2) domain：域名规则，例如.qq.com 示例值：.qq.com
DestType	String	是	访问目的类型，类型可以为：net，domain，dnsparse 示例值：net
Protocol	String	是	协议，可选的值： TCP UDP ICMP ANY HTTP HTTPS HTTP/HTTPS SMTP SMTPS SMTP/SMTPS FTP DNS TLS/SSL 示例值：ANY
RuleAction	String	是	访问控制策略中设置的流量通过云防火墙的方式。取值： accept：放行 drop：拒绝 log：观察 示例值：accept
Port	String	是	访问控制策略的端口。取值： -1/-1：全部端口 80：80端口 示例值：-1/-1
Description	String	是	描述 示例值：andy使用的模板
OrderIndex	Integer	是	规则顺序，-1表示最低，1表示最高 示例值：-1
Enable	String	是	规则状态，true表示启用，false表示禁用 示例值：true
EdgeId	String	是	规则生效的范围，是在哪对vpc之间还是针对所有vpc间生效 示例值：cfws-d92f04f8或者ALL
Uuid	Integer	否	规则对应的唯一id，添加规则时忽略该字段，修改该规则时需要填写Uuid;查询返回时会返回该参数 示例值：8888
DetectedTimes	Integer	否	规则的命中次数，增删改查规则时无需传入此参数，主要用于返回查询结果数据 示例值：0
EdgeName	String	否	EdgeId对应的这对VPC间防火墙的描述 示例值：andy的edge
InternalUuid	Integer	否	内部使用的uuid，一般情况下不会使用到该字段 示例值：8921
Deleted	Integer	否	规则被删除：1，已删除；0，未删除 示例值：0
FwGroupId	String	否	规则生效的防火墙实例ID 示例值：cfwew-d92f04f8
FwGroupName	String	否	防火墙名称 示例值：防火墙名称
BetaList	Array of BetaInfoByACL	否	beta任务详情 示例值：[{"TaskId":"9001","TaskName":"autotest","LastTime":"1999-01-01 00:00:01"}]
ParamTemplateId	String	否	端口协议组ID 示例值：pp-1q2w3e4r
ParamTemplateName	String	否	端口协议组名称 示例值：常用参数模版
TargetName	String	否	访问目的名称 示例值：目的Cvm
SourceName	String	否	访问源名称 示例值：来源实例
IpVersion	Integer	否	Ip版本，0：IPv4，1：IPv6，默认为IPv4 示例值：0
Invalid	Integer	否	是否是无效规则，0 表示有效规则，1 表示无效规则，出参场景返回使用 示例值：0

VpcZoneData

vpc区域数据详情

被如下接口引用：CreateChooseVpcs。

名称	类型	必选	描述
Zone	String	是	可用区 示例值：ap-shanghai-5
Region	String	是	vpc节点地域 示例值：ap-shanghai