有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

AcListsData

访问控制列表对象

被如下接口引用:DescribeAcLists。

名称 类型 描述
Id Integer 规则id
示例值:1
SourceIp String 访问源
注意:此字段可能返回 null,表示取不到有效值。
TargetIp String 访问目的
注意:此字段可能返回 null,表示取不到有效值。
Protocol String 协议
注意:此字段可能返回 null,表示取不到有效值。
Port String 端口
注意:此字段可能返回 null,表示取不到有效值。
Strategy Integer 策略
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Detail String 描述
注意:此字段可能返回 null,表示取不到有效值。
Count Integer 命中次数
示例值:1
OrderIndex Integer 执行顺序
示例值:1
LogId String 告警规则id
注意:此字段可能返回 null,表示取不到有效值。

AssetZone

AssetZone

被如下接口引用:DescribeSourceAsset。

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

AssociatedInstanceInfo

企业安全组关联实例信息

被如下接口引用:DescribeAssociatedInstanceList。

名称 类型 必选 描述
InstanceId String 实例ID
注意:此字段可能返回 null,表示取不到有效值。
InstanceName String 实例名称
注意:此字段可能返回 null,表示取不到有效值。
Type Integer 实例类型,3是cvm实例,4是clb实例,5是eni实例,6是云数据库
注意:此字段可能返回 null,表示取不到有效值。
VpcId String 私有网络ID
注意:此字段可能返回 null,表示取不到有效值。
VpcName String 私有网络名称
注意:此字段可能返回 null,表示取不到有效值。
PublicIp String 公网IP
注意:此字段可能返回 null,表示取不到有效值。
Ip String 内网IP
注意:此字段可能返回 null,表示取不到有效值。
SecurityGroupCount Integer 关联安全组数量
注意:此字段可能返回 null,表示取不到有效值。
SecurityGroupRuleCount Integer 关联安全组规则数量
注意:此字段可能返回 null,表示取不到有效值。
CdbId String 关联数据库代理Id
注意:此字段可能返回 null,表示取不到有效值。

BanAndAllowRule

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

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

名称 类型 必选 描述
Ioc String 封禁和放通对象
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.2.3.4
DirectionList String 0互联网出站 1互联网入站 5内网访问源 6内网访问目的
注意:此字段可能返回 null,表示取不到有效值。
示例值:0,1
EndTime String 规则截止时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:3000-01-01 00:00:00
Comment String 规则评论
注意:此字段可能返回 null,表示取不到有效值。
示例值:生产环境放通
CustomRule CustomWhiteRule 自定义白名单规则
注意:此字段可能返回 null,表示取不到有效值。

BanAndAllowRuleDel

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

被如下接口引用:DeleteBlockIgnoreRuleNew。

名称 类型 必选 描述
Ioc String 封禁和放通对象
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.2.3.4
DirectionList String 0互联网出站 1互联网入站 5内网访问源 6内网访问目的
注意:此字段可能返回 null,表示取不到有效值。
示例值:0,1
RuleType Integer 规则类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:RuleType: 1黑名单 2外部IP 3域名 4情报 5资产 6自定义规则 7入侵防御规则

BetaInfoByACL

规则关联的beta任务

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

名称 类型 必选 描述
TaskId Integer 任务id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1001
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:任务xxx
LastTime String 上次执行时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-03-02 10:00:00

BlockIgnoreRule

入侵防御放通封禁规则

被如下接口引用:DescribeBlockIgnoreList。

名称 类型 描述
RuleType Integer 1 封禁 2外部IP 3域名 4情报 5assets 6udf 7入侵防御规则id (2-7属于白名单类型)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Ioc String 规则ip或白名单内容
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.1.1.1
IocName String 资产实例名称、自定义策略名称等
注意:此字段可能返回 null,表示取不到有效值。
示例值:名称名称
IocInfo String 白名单信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:广东省深圳市
Domain String 域名
注意:此字段可能返回 null,表示取不到有效值。
IP String IP
注意:此字段可能返回 null,表示取不到有效值。
Level String 危险等级
注意:此字段可能返回 null,表示取不到有效值。
示例值:未知
EventName String 来源事件名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:封禁列表命中
Direction Integer 方向:1入站,0出站
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DirectionList String 所有方向聚合成字符串
注意:此字段可能返回 null,表示取不到有效值。
示例值:0,1
Protocol String 协议
注意:此字段可能返回 null,表示取不到有效值。
示例值:TCP
Address String 地理位置
注意:此字段可能返回 null,表示取不到有效值。
示例值:中国广东省广州
Action Integer 规则类型:1封禁,2放通
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
StartTime String 规则生效开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-09-21 12:00:00
EndTime String 规则生效结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:3000-01-01 00:00:00
IgnoreReason String 忽略原因
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Source String 安全事件来源
注意:此字段可能返回 null,表示取不到有效值。
示例值:手动添加
UniqueId String 规则id
注意:此字段可能返回 null,表示取不到有效值。
示例值:UniqueId
MatchTimes Integer 规则命中次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Country String 国家
注意:此字段可能返回 null,表示取不到有效值。
示例值:中国
Comment String 备注
注意:此字段可能返回 null,表示取不到有效值。
示例值:comment
LastHitTime String 上次命中时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-09-21 12:00:00
CustomRule CustomWhiteRule 自定义规则细节
注意:此字段可能返回 null,表示取不到有效值。

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防火墙转发规则描述。
示例值:test

CommonFilter

通用的列表检索过滤选项

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

名称 类型 必选 描述
Name String 检索的键值
示例值:src_ip
Values Array of String 检索的值,各检索值间为OR关系
示例值:["1.1.1.1","2.2.2.2"]
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

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 描述
示例值:test
ParamTemplateId String 端口协议组ID
示例值:pp-1q2w3e4r
InternalUuid Integer 内部id
示例值:xxx

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
示例值: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 描述
示例值:test
Scope String all
示例值:生效范围:serial,串行;side,旁路;all,全局
RuleSource Integer 0,正常规则添加;1,入侵检测添加
示例值:0
LogId String 告警Id
ParamTemplateId String 端都协议组ID
示例值:pp-1q2w3e4r

CustomWhiteRule

自定义白名单规则

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

名称 类型 必选 描述
SrcIP String 访问源
注意:此字段可能返回 null,表示取不到有效值。
示例值:12.11.23.123
DstIP String 访问目的
注意:此字段可能返回 null,表示取不到有效值。
示例值:111.11.1.2
IdsRuleName String 规则名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:xx漏洞
IdsRuleId String 规则ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:20001

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 访问源
注意:此字段可能返回 null,表示取不到有效值。
TargetContent String 访问目的
注意:此字段可能返回 null,表示取不到有效值。
Protocol String 协议
注意:此字段可能返回 null,表示取不到有效值。
Port String 端口
注意:此字段可能返回 null,表示取不到有效值。
RuleAction String 访问控制策略中设置的流量通过云防火墙的方式。取值: accept:放行 drop:拒绝 log:观察
注意:此字段可能返回 null,表示取不到有效值。
示例值:accept
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。
Count Integer 命中次数
示例值:1
OrderIndex Integer 执行顺序
示例值:1
SourceType String 访问源类型:入向规则时类型可以为 ip,net,template,location;出向规则时可以为 ip,net,template,instance,group,tag
注意:此字段可能返回 null,表示取不到有效值。
示例值:ip
TargetType String 访问目的类型:入向规则时类型可以为ip,net,template,instance,group,tag;出向规则时可以为 ip,net,domain,template,location,dnsparse
注意:此字段可能返回 null,表示取不到有效值。
示例值:ip
Uuid Integer 规则对应的唯一id
注意:此字段可能返回 null,表示取不到有效值。
示例值:8888
Invalid Integer 规则有效性
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
IsRegion Integer 0为正常规则,1为地域规则
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
CountryCode Integer 国家id
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
CityCode Integer 城市id
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
CountryName String 国家名称
注意:此字段可能返回 null,表示取不到有效值。
CityName String 省名称
注意:此字段可能返回 null,表示取不到有效值。
CloudCode String 云厂商code
注意:此字段可能返回 null,表示取不到有效值。
IsCloud Integer 0为正常规则,1为云厂商规则
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Enable String 规则状态,true表示启用,false表示禁用
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
Direction Integer 规则方向:1,入向;0,出向
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
InstanceName String 实例名称
注意:此字段可能返回 null,表示取不到有效值。
InternalUuid Integer 内部使用的uuid,一般情况下不会使用到该字段
注意:此字段可能返回 null,表示取不到有效值。
示例值:123456789
Status Integer 规则状态,查询规则命中详情时该字段有效,0:新增,1: 已删除, 2: 编辑删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
BetaList Array of BetaInfoByACL 关联任务详情
注意:此字段可能返回 null,表示取不到有效值。
Scope String 生效范围:serial,串行;side,旁路;all,全局
注意:此字段可能返回 null,表示取不到有效值。
示例值:all
InternetBorderUuid String 互联网边界防火墙使用的内部规则id
注意:此字段可能返回 null,表示取不到有效值。
示例值:互联网边界Uuid
ParamTemplateName String 协议端口组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
ParamTemplateId String 协议端口组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:pp-1q2w3e4r
SourceName String 访问源名称
注意:此字段可能返回 null,表示取不到有效值。
TargetName String 访问目的名称
注意:此字段可能返回 null,表示取不到有效值。

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 类型
注意:此字段可能返回 null,表示取不到有效值。
InstanceId String 实例ID
注意:此字段可能返回 null,表示取不到有效值。
InstanceName String 实例名
注意:此字段可能返回 null,表示取不到有效值。
IntranetIp String 内网IP
注意:此字段可能返回 null,表示取不到有效值。
AssetType String 资产类型
注意:此字段可能返回 null,表示取不到有效值。
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
PortRiskCount Integer 风险端口数
注意:此字段可能返回 null,表示取不到有效值。
LastScanTime String 最近扫描时间
注意:此字段可能返回 null,表示取不到有效值。
IsRegionEip Integer 是否为region eip
0 不为region eip,不能选择串行
1 为region eip 可以选择串行
注意:此字段可能返回 null,表示取不到有效值。
VpcId String EIP 所关联的VPC
注意:此字段可能返回 null,表示取不到有效值。
IsSerialRegion Integer 0: 该地域暂未支持串行
1: 该用户未在该地域配置串行带宽
2: 该用户已在该地域配置串行带宽,可以开启串行开关
注意:此字段可能返回 null,表示取不到有效值。
IsPublicClb Integer 0: 不是公网CLB 可以开启串行开关
1: 是公网CLB 不可以开启串行开关

注意:此字段可能返回 null,表示取不到有效值。
EndpointBindEipNum Integer 0: 开启开关时提示要创建私有连接。
1: 关闭该开关是提示删除私有连接。
如果大于 1: 关闭开关 、开启开关不需提示创建删除私有连接。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ScanMode String 扫描深度
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ScanStatus Integer 扫描状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Status Integer 开关状态
0 : 关闭
1 : 开启
2 : 开启中
3 : 关闭中
4 : 异常
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
EndpointId String 私有连接ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:vpce-xxxxxxxx
EndpointIp String 私有连接IP
注意:此字段可能返回 null,表示取不到有效值。
示例值:10.10.10.10
SwitchMode Integer 0 : 旁路
1 : 串行
2 : 正在模式切换
示例值:0
SwitchWeight Integer 开关权重
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Domain String 域名化CLB的域名
注意:此字段可能返回 null,表示取不到有效值。
示例值:www.qq.com

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

FwCidrInfo

防火墙网段信息

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

名称 类型 必选 描述
FwCidrType String 防火墙使用的网段类型,值VpcSelf/Assis/Custom分别代表自有网段优先/扩展网段优先/自定义
示例值:VpcSelf
FwCidrLst Array of FwVpcCidr 为每个vpc指定防火墙的网段
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-xxx
VpcId String 网关所属vpc id
注意:此字段可能返回 null,表示取不到有效值。
示例值:vpc-xxx
IpAddress String 网关ip地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:192.168.1.1/24

FwGroupSwitch

多种VPC墙模式开关结构

被如下接口引用:ModifyFwGroupSwitch。

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

FwGroupSwitchShow

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

被如下接口引用:DescribeVpcFwGroupSwitch。

名称 类型 描述
SwitchId String 防火墙开关ID
示例值:cfws-xxxxxxxx
SwitchName String 防火墙开关NAME
注意:此字段可能返回 null,表示取不到有效值。
示例值:aaaa-bbbb开关
SwitchMode Integer 互通模式
示例值:1
ConnectType Integer 开关边连接类型 0:对等连接, 1:云连网
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ConnectId String 连接ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:ccn-58cqznrf
ConnectName String 连接名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:云联网ccn防火墙开发--勿删
SrcInstancesInfo Array of NetInstancesInfo 源实例信息
注意:此字段可能返回 null,表示取不到有效值。
DstInstancesInfo Array of NetInstancesInfo 目的实例信息
注意:此字段可能返回 null,表示取不到有效值。
FwGroupId String 防火墙(组)数据
注意:此字段可能返回 null,表示取不到有效值。
FwGroupName String 防火墙(组)名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:视死忽如归
Enable Integer 开关状态 0:关 , 1:开
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Status Integer 开关的状态 0:正常, 1:转换中
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
AttachWithEdge Integer 0-非sase实例,忽略,1-未绑定状态,2-已绑定
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
CrossEdgeStatus Integer 对等防火墙和开关状态 0:正常, 1:对等未创建防火墙,2:对等已创建防火墙,未打开开关
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
FwInsRegion Array of String 网络经过VPC防火墙CVM所在地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-chongqing
IpsAction Integer 0 观察 1 拦截 2 严格 3 关闭 4 不支持ips 前端展示tag
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
FwInsLst Array of VpcFwInstanceShow 开关关联的防火墙实例列表
注意:此字段可能返回 null,表示取不到有效值。
BypassStatus Integer 开关是否处于bypass状态
0:正常状态
1:bypass状态
注意:此字段可能返回 null,表示取不到有效值。
示例值: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
注意:此字段可能返回 null,表示取不到有效值。
示例值:50
SrcIp String 源IP
注意:此字段可能返回 null,表示取不到有效值。
示例值:10.23.22.1
DstIp String 目的IP
注意:此字段可能返回 null,表示取不到有效值。
示例值:10.23.22.2
WhiteRuleType String 规则类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:srddst
FwType Integer 白名单生效防火墙范围: 1 边界防火墙 2 nat防火墙 4 vpc防火墙 7 = 1+2+4 所有防火墙
注意:此字段可能返回 null,表示取不到有效值。
示例值:7
RuleId String 入侵防御规则ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:20016

InstanceInfo

// InstanceInfo 实例详情结果
type InstanceInfo struct {
AppID string json:"AppId" gorm:"column:appid"
Region string json:"Region" gorm:"column:region"
VPCID string json:"VpcId" gorm:"column:vpc_id"
SubNetID string json:"SubnetId" gorm:"column:subnet_id"
InstanceID string json:"InstanceId" gorm:"column:instance_id"
InstanceName string json:"InstanceName" gorm:"column:instance_name"
//InsType common.CVM 3是cvm实例,4是clb实例,5是eni实例,6是mysql,7是redis,8是NAT,9是VPN,10是ES,11是MARIADB,12是KAFKA
InsType int json:"InsType" gorm:"column:instance_type"
PublicIP string json:"PublicIp" gorm:"column:public_ip"
PrivateIP string json:"PrivateIp" gorm:"column:ip"

//规则下发无需管,前端展示用
PortNum          string <dx-inline-code-holder></dx-inline-code-holder>
LeakNum          string <dx-inline-code-holder></dx-inline-code-holder>
ResourceGroupNum int    <dx-inline-code-holder></dx-inline-code-holder>
VPCName          string <dx-inline-code-holder></dx-inline-code-holder>

}

被如下接口引用:DescribeSourceAsset。

名称 类型 描述
AppId String appid信息
示例值:1300448058
Region String 地域
示例值:上海
VpcId String vpcid信息
示例值:vpc-aa
VPCName String vpc名称
示例值:vpcname-1
SubnetId String 子网id
示例值:sub-test
InstanceId String 资产id
示例值:ins-888
InstanceName String 资产名
示例值:test
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
PublicIp String 公网ip
示例值:120.11.85.5,211.10,2.,5
PrivateIp String 内网ip
示例值:172.11.85.5
PortNum String 端口数
示例值:1
LeakNum String 漏洞数
示例值:0
InsSource String 1,公网 2内网
示例值:资产类型
ResourcePath Array of String [a,b]
注意:此字段可能返回 null,表示取不到有效值。
示例值:资产路径
Server Array of String 扫描结果
注意:此字段可能返回 null,表示取不到有效值。
RegionKey String 地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:上海

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
Comment String 备注信息,长度不能超过50
示例值:放通ip
StartTime String 规则开始时间
示例值:2021-09-21 12:00:00

IocListData

封禁放通IOC列表

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

名称 类型 必选 描述
IP String 待处置IP地址,IP/Domain字段二选一
注意:此字段可能返回 null,表示取不到有效值。
示例值:192.168.1.1
Direction Integer 只能为0或者1 0代表出站 1代表入站
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Domain String 待处置域名,IP/Domain字段二选一
注意:此字段可能返回 null,表示取不到有效值。
示例值: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
注意:此字段可能返回 null,表示取不到有效值。
示例值:nat-7cq345j4
NatGatewayName String Nat网关名称
注意:此字段可能返回 null,表示取不到有效值。
示例值: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 实例所在地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-shanghai
FwMode Integer 0:新增模式,1:接入模式
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Status Integer 0:正常状态, 1: 正在创建
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
NatIp String nat公网ip
注意:此字段可能返回 null,表示取不到有效值。
示例值: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数组
注意:此字段可能返回 null,表示取不到有效值。
示例值:["106.55.4.81"]
VpcIp Array of String 内外使用ip数组
注意:此字段可能返回 null,表示取不到有效值。
示例值:["10.255.1.20"]
Subnets Array of String 实例关联子网数组
注意:此字段可能返回 null,表示取不到有效值。
示例值:["subnet-0fl56e31"]
Status Integer 0 :正常 1:正在初始化
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
RegionDetail String 地域区域信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:华南地区
ZoneZh String 实例所在可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:广州六区
ZoneZhBak String 实例所在可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:广州七区
RuleUsed Integer 已使用规则数
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
RuleMax Integer 实例的规则限制最大规格数
注意:此字段可能返回 null,表示取不到有效值。
示例值:5000
EngineVersion String 实例引擎版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:cfw_3.7.0.888
UpdateEnable Integer 引擎是否可升级:0,不可升级;1,可升级
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
NeedProbeEngineUpdate Integer 是的需要升级引擎 支持 nat拨测 1需要 0不需要
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TrafficMode String 引擎运行模式,Normal:正常, OnlyRoute:透明模式
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Zone String 实例主所在可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou-6
ZoneBak String 实例备所在可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou-7
ReserveTime String 引擎预约升级时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-12-09 11:56:58
ReserveVersion String 引擎预约升级版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:cfw_3.8.0.888
ReserveVersionState String 引擎预约升级版本状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:stable
ElasticSwitch Integer 弹性开关
1 打开
0 关闭
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ElasticBandwidth Integer 弹性带宽,单位Mbps
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
IsFirstAfterPay Integer 是否首次开通按量付费
1 是
0 不是
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

NatSwitchListData

NAT防火墙开关列表数据

被如下接口引用:DescribeNatSwitchList。

名称 类型 描述
Id Integer 列表ID
示例值:1
SubnetId String 子网ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:subnet-k9t82usg
SubnetName String 子网名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:add2
SubnetCidr String IPv4 CIDR
注意:此字段可能返回 null,表示取不到有效值。
示例值:172.30.64.0/20
RouteId String 关联路由ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:rtb-rfm44194
RouteName String 关联路由名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:route_ruri
CvmNum Integer 云服务器个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
VpcId String 所属VPC ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:vpc-5oofojsr
VpcName String 所属VPC名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:Default-VPC
Enable Integer 是否生效
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Status Integer 开关状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
NatId String NAT网关ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:nat-pfkjetae
NatName String NAT网关名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:second
NatInsId String NAT防火墙实例ID
注意:此字段可能返回 null,表示取不到有效值。
NatInsName String NAT防火墙实例名称
注意:此字段可能返回 null,表示取不到有效值。
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
Abnormal Integer 开关是否异常,0:正常,1:异常
注意:此字段可能返回 null,表示取不到有效值。

NetInstancesInfo

网络实例信息

被如下接口引用:DescribeVpcFwGroupSwitch。

名称 类型 描述
InstanceId String 网络实例ID
注意:此字段可能返回 null,表示取不到有效值。
示例值: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

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 描述
示例值:描述
TargetType Integer 访问目的类型,1是IP,3是域名,4是IP地址模板,5是域名地址模板
示例值:1
Port String 端口
示例值:80
Id Integer id值
示例值:1
LogId String 日志id,从告警处创建必传,其它为空
示例值:1
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代码或者省份缩写代码
示例值:gb

ScanInfo

新手引导扫描信息

被如下接口引用:DescribeGuideScanInfo。

名称 类型 描述
ScanResultInfo ScanResultInfo 扫描结果信息
示例值: "ScanResultInfo": { "PortNum": 0, 暴露端口
ScanStatus Integer 扫描状态 0扫描中 1完成 2未勾选自动扫描
示例值:1
ScanPercent Float 进度
示例值:0.55
ScanTime String 预计完成时间
示例值:2021-04-17 12:20:03

ScanResultInfo

新手引导扫描结果信息PortNum int
LeakNum int
IPNum int
IPStatus bool
IdpStatus bool
BanStatus bool

被如下接口引用:DescribeGuideScanInfo。

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

SecurityGroupBothWayInfo

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

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

名称 类型 必选 描述
OrderIndex Integer 执行顺序
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SourceId String 访问源
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
SourceType Integer 访问源类型,默认为0,0: IP, 1: VPC, 2: SUBNET, 3: CVM, 4: CLB, 5: ENI, 6: CDB, 7: 参数模板, 100: 资产分组
注意:此字段可能返回 null,表示取不到有效值。
示例值:7
TargetId String 访问目的
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
TargetType Integer 访问目的类型,默认为0,0: IP, 1: VPC, 2: SUBNET, 3: CVM, 4: CLB, 5: ENI, 6: CDB, 7: 参数模板, 100: 资产分组
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
Protocol String 协议
注意:此字段可能返回 null,表示取不到有效值。
示例值:ANY
Port String 目的端口
注意:此字段可能返回 null,表示取不到有效值。
示例值:-1/-1
Strategy Integer 策略, 1:阻断,2:放行
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
Direction Integer 方向,0:出站,1:入站,默认1
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Region String 地域
示例值:ap-guangzhou
Detail String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
Status Integer 是否开关开启,0:未开启,1:开启
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
IsNew Integer 是否是正常规则,0:正常,1:异常
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
BothWay Integer 单/双向下发,0:单向下发,1:双向下发
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
VpcId String 私有网络ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
SubnetId String 子网ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
InstanceName String 实例名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
PublicIp String 公网IP,多个以英文逗号分隔
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
PrivateIp String 内网IP,多个以英文逗号分隔
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
Cidr String 掩码地址,多个以英文逗号分隔
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
ServiceTemplateId String 端口协议类型参数模板id
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
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 描述
示例值:test
BothWay Integer 单/双向下发,0:单向下发,1:双向下发
示例值:0
Id Integer 规则ID
示例值:1
Status Integer 是否开关开启,0:未开启,1:开启
示例值:1
IsNew Integer 是否是正常规则,0:正常,1:异常
示例值:1
VpcId String 私有网络ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:vpc-8xuf8kf5
SubnetId String 子网ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:subnet-fmo10koi
InstanceName String 实例名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:InstanceName
PublicIp String 公网IP,多个以英文逗号分隔
注意:此字段可能返回 null,表示取不到有效值。
示例值:PublicIp
PrivateIp String 内网IP,多个以英文逗号分隔
注意:此字段可能返回 null,表示取不到有效值。
示例值:PrivateIp
Cidr String 掩码地址,多个以英文逗号分隔
注意:此字段可能返回 null,表示取不到有效值。
示例值:Cidr
ServiceTemplateId String 端口协议类型参数模板id
注意:此字段可能返回 null,表示取不到有效值。
示例值:ppmg-jz17vpis
BothWayInfo Array of SecurityGroupBothWayInfo 生成双向下发规则
注意:此字段可能返回 null,表示取不到有效值。
示例值:BothWayInfo
Direction Integer 方向,0:出站,1:入站,默认1
示例值:0
ProtocolPortType Integer 是否使用端口协议模板,0:否,1:是
示例值:1
Uuid String Uuid
注意:此字段可能返回 null,表示取不到有效值。
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
AssetGroupNameIn String 资产分组名称
注意:此字段可能返回 null,表示取不到有效值。
AssetGroupNameOut String 资产分组名称
注意:此字段可能返回 null,表示取不到有效值。
ParameterName String 模板名称
注意:此字段可能返回 null,表示取不到有效值。
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 描述
示例值:test
OrderIndex String 规则顺序,-1表示最低,1表示最高,请勿和外层Type冲突(和外层的Type配合使用,当中间插入时,指定添加位置)
示例值:-1
Protocol String 协议;TCP/UDP/ICMP/ANY
注意:此字段可能返回 null,表示取不到有效值。
示例值:ANY
Port String 访问控制策略的端口。取值:
-1/-1:全部端口
80:80端口
注意:此字段可能返回 null,表示取不到有效值。
示例值:-1/-1
ServiceTemplateId String 端口协议类型参数模板id;协议端口模板id;与Protocol,Port互斥
注意:此字段可能返回 null,表示取不到有效值。
示例值:ppmg-jz17vpis
Id String (入参时无需填写,自动生成)规则对应的唯一id
示例值:8888
Enable String (入参时、Enable已弃用;由通用配置中新增规则启用状态控制)
规则状态,true表示启用,false表示禁用
示例值:true
Uid String 规则对应的唯一内部id
示例值:xxx

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)
注意:此字段可能返回 null,表示取不到有效值。
示例值: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)
注意:此字段可能返回 null,表示取不到有效值。
示例值:ins-fmo10koi
Protocol String 协议;TCP/UDP/ICMP/ANY
注意:此字段可能返回 null,表示取不到有效值。
示例值:ANY
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
RuleUuid Integer 规则对应的唯一id
注意:此字段可能返回 null,表示取不到有效值。
示例值:8888
Sequence Integer 规则序号
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

SequenceData

执行顺序对象

被如下接口引用:ModifySequenceRules。

名称 类型 必选 描述
Id Integer 规则Id值
OrderIndex Integer 修改前执行顺序
NewOrderIndex Integer 修改后执行顺序

StaticInfo

StaticInfo 告警柱形图统计信息

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

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

SwitchListsData

防火墙开关列表对象

被如下接口引用:DescribeSwitchLists。

名称 类型 描述
PublicIp String 公网IP
注意:此字段可能返回 null,表示取不到有效值。
IntranetIp String 内网IP
注意:此字段可能返回 null,表示取不到有效值。
InstanceName String 实例名
注意:此字段可能返回 null,表示取不到有效值。
InstanceId String 实例ID
注意:此字段可能返回 null,表示取不到有效值。
AssetType String 资产类型
Area String 地域
注意:此字段可能返回 null,表示取不到有效值。
Switch Integer 防火墙开关
Id Integer id值
PublicIpType Integer 公网 IP 类型
注意:此字段可能返回 null,表示取不到有效值。
PortTimes Integer 风险端口数
注意:此字段可能返回 null,表示取不到有效值。
LastTime String 最近扫描时间
注意:此字段可能返回 null,表示取不到有效值。
ScanMode String 扫描深度
注意:此字段可能返回 null,表示取不到有效值。
ScanStatus Integer 扫描状态
注意:此字段可能返回 null,表示取不到有效值。

TLogInfo

告警中心概览数据

被如下接口引用:DescribeTLogInfo。

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

TagInfo

标签信息

被如下接口引用:ExpandCfwVertical。

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

TemplateListInfo

地址模板列表数据

被如下接口引用:DescribeAddressTemplateList。

名称 类型 描述
Uuid String 模板ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:mb_1300448058_1636944838448
Name String 模板名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:abc
Detail String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:whitelist
IpString String IP模板
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.1.1.1
InsertTime String 插入时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-11-15 10:53:58
UpdateTime String 修改时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-11-15 10:53:58
Type Integer 模板类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RulesNum Integer 关联规则条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TemplateId String 模板Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:pp-test
ProtocolType String 协议端口模板,协议类型,4:4层协议,7:7层协议
注意:此字段可能返回 null,表示取不到有效值。
示例值:4
IPNum Integer 模板包含地址数量
注意:此字段可能返回 null,表示取不到有效值。

UnHandleEvent

未处置事件详情

被如下接口引用:DescribeUnHandleEventTabList。

名称 类型 描述
EventTableListStruct Array of UnHandleEventDetail 伪攻击链类型
示例值:漏洞利用
BaseLineUser Integer 1 是 0否
示例值:1
BaseLineInSwitch Integer 1 打开 0 关闭
示例值:1
BaseLineOutSwitch Integer 1 打开 0 关闭
示例值:1
VpcFwCount Integer vpc间防火墙实例数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

UnHandleEventDetail

未处置事件信息汇总

被如下接口引用:DescribeUnHandleEventTabList。

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

VpcDnsInfo

nat防火墙 vpc dns 开关信息

被如下接口引用:DescribeNatFwVpcDnsLst。

名称 类型 描述
VpcId String vpc id
示例值:vpc-ilbrv877
VpcName String vpc 名称
示例值:yw
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
注意:此字段可能返回 null,表示取不到有效值。
示例值:nat-2irqlrfj
NatInsName String nat网关名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1111
SwitchStatus Integer 0:开关关闭 , 1: 开关打开
示例值:1
ProtectedStatus Integer 0:未防护, 1: 已防护,2:忽略此字段
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SupportDNSFW Integer 是否支持DNS FW,0-不支持、1-支持
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

VpcFwCvmInsInfo

VPC防火墙实例的CVM信息

被如下接口引用:DescribeFwGroupInstanceInfo。

名称 类型 必选 描述
FwInsId String VPC防火墙实例ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cfwew-af7aa5a3
Region String CVM所在地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-chengdu
RegionZh String CVM所在地域中文
注意:此字段可能返回 null,表示取不到有效值。
示例值:成都
RegionDetail String CVM所在地域详情
注意:此字段可能返回 null,表示取不到有效值。
示例值:西南地区
ZoneZh String 主机所在可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:成都一区
ZoneZhBack String 备机所在可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:成都二区
BandWidth Integer 防火墙CVM带宽值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1024
Zone String 实例主机所在可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-chengdu-1
ZoneBak String 实例备机所在可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-chengdu-2

VpcFwGroupInfo

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

被如下接口引用:DescribeFwGroupInstanceInfo。

名称 类型 描述
FwGroupId String 防火墙(组)ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cfwg-xxxxxxxx
FwGroupName String 防火墙(组)名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:捐躯赴国难
FwSwitchNum Integer 防火墙组涉及到的开关个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
RegionLst Array of String 防火墙(组)部署的地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:['ap-guangzhou']
Mode Integer 模式 1:CCN云联网模式;0:私有网络模式 2: sase 模式 3:ccn 高级模式 4: 私有网络(跨租户单边模式)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SwitchMode Integer 防火墙实例的开关模式 1: 单点互通 2: 多点互通 3: 全互通 4: 自定义路由
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
FwInstanceLst Array of VpcFwInstanceInfo VPC防火墙实例卡片信息数组
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 防火墙(状态) 0:正常 1: 初始化或操作中
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
FwVpcCidr String auto :自动选择
如果为网段,则为用户自定义 192.168.0.0/20
示例值:auto
CdcId String cdc专用集群场景时表示部署所属的cdc
注意:此字段可能返回 null,表示取不到有效值。
示例值:cluster-xxx
CdcName String cdc专用集群场景时表示cdc名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
CrossUserMode String 跨租户模式 1管理员 2单边 0 非跨租户
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

VpcFwInstance

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

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

名称 类型 必选 描述
Name String 防火墙实例名称
示例值:test
VpcIds Array of String 私有网络模式下接入的VpcId列表;仅私有网络模式使用
示例值:["vpc-xxx","vpc-xxx"]
FwDeploy FwDeploy 部署地域信息
示例值:{"DeployRegion":"ap-nanjing","Width":500}
FwInsId String 防火墙实例ID (编辑场景传)
示例值:cfwew-xxxxxxxx

VpcFwInstanceInfo

VPC防火墙实例卡片信息

被如下接口引用:DescribeFwGroupInstanceInfo。

名称 类型 必选 描述
FwInsName String VPC防火墙实例名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:沉舟侧畔千帆过,病树前头万木春
FwInsId String VPC防火墙实例ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cfwew-de1a3a1a
FwMode Integer VPC防火墙实例模式 0: 旧VPC模式防火墙 1: CCN模式防火墙
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
JoinInsNum Integer VPC防火墙接入网络实例个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:8
FwSwitchNum Integer VPC防火墙开关个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:8
Status Integer VPC防火墙状态 0:正常 , 1:创建中 2: 变更中
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Time String VPC防火墙创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-12-09 11:56:58
CcnId Array of String VPC 相关云联网ID列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:["ccn-58cqznrf"]
CcnName Array of String VPC 相关云联网名称列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:["云联网ccn防火墙开发--勿删"]
PeerConnectionId Array of String VPC 相关对等连接ID列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
PeerConnectionName Array of String VPC 相关对等连接名称列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
FwCvmLst Array of VpcFwCvmInsInfo VPC防火墙CVM的列表
注意:此字段可能返回 null,表示取不到有效值。
JoinInsLst Array of VpcFwJoinInstanceType VPC防火墙接入网络实例类型列表
注意:此字段可能返回 null,表示取不到有效值。
FwGateway Array of FwGateway 防火墙网关信息
注意:此字段可能返回 null,表示取不到有效值。
FwGroupId String 防火墙(组)ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cfwg-xxxxxxxx
RuleUsed Integer 已使用规则数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
RuleMax Integer 最大规则数
注意:此字段可能返回 null,表示取不到有效值。
示例值:5000
Width Integer 防火墙实例带宽
注意:此字段可能返回 null,表示取不到有效值。
示例值:1024
UserVpcWidth Integer 用户VPC墙总带宽
注意:此字段可能返回 null,表示取不到有效值。
示例值:5000
JoinInsIdLst Array of String 接入的vpc列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:["vpc-abcdabcd"]
FlowMax Integer 内网间峰值带宽 (单位 bps )
示例值:1000
EngineVersion String 实例引擎版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:cfw_3.7.0.888
UpdateEnable Integer 引擎是否可升级:0,不可升级;1,可升级
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
TrafficMode String 引擎运行模式,Normal:正常, OnlyRoute:透明模式
注意:此字段可能返回 null,表示取不到有效值。
示例值:Normal
ReserveTime String 引擎预约升级时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-12-09 11:56:58
ReserveVersion String 预约引擎升级版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:cfw_3.8.0.888
ReserveVersionState String 引擎预约升级版本状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:stable
ElasticSwitch Integer 弹性开关 1打开 0关闭
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ElasticBandwidth Integer 弹性带宽,单位Mbps
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
IsFirstAfterPay Integer 是否首次开通按量付费
1 是
0 不是
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

VpcFwInstanceShow

VPC防火墙实例信息

被如下接口引用:DescribeVpcFwGroupSwitch。

名称 类型 描述
FwInsId String VPC防火墙实例ID
示例值:cfwew-af7aa5a3
FwInsName String VPC防火墙实例名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:春城无处不飞花
FwInsRegion String 网络经过VPC防火墙CVM所在地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-chongqing

VpcFwJoinInstanceType

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

被如下接口引用:DescribeFwGroupInstanceInfo。

名称 类型 必选 描述
JoinType String 接入实例类型,VPC、DIRECTCONNECT、 VPNGW 等
注意:此字段可能返回 null,表示取不到有效值。
示例值:VPC
Num Integer 接入的对应网络实例类型的数量
注意:此字段可能返回 null,表示取不到有效值。
示例值: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
注意:此字段可能返回 null,表示取不到有效值。
示例值:ANY
RuleAction String 访问控制策略中设置的流量通过云防火墙的方式。取值:
accept:放行
drop:拒绝
log:观察
示例值:accept
Port String 访问控制策略的端口。取值:
-1/-1:全部端口
80:80端口
注意:此字段可能返回 null,表示取不到有效值。
示例值:-1/-1
Description String 描述
示例值:test
OrderIndex Integer 规则顺序,-1表示最低,1表示最高
示例值:-1
Uuid Integer 规则对应的唯一id
示例值:8888
Enable String 规则状态,true表示启用,false表示禁用
示例值:true
EdgeId String 规则生效的范围,是在哪对vpc之间还是针对所有vpc间生效
示例值:cfws-xxx或者ALL
DetectedTimes Integer 规则的命中次数,增删改查规则时无需传入此参数,主要用于返回查询结果数据
示例值:0
EdgeName String EdgeId对应的这对VPC间防火墙的描述
示例值:描述信息
InternalUuid Integer 内部使用的uuid,一般情况下不会使用到该字段
示例值:123456789
Deleted Integer 规则被删除:1,已删除;0,未删除
示例值:0
FwGroupId String 规则生效的防火墙实例ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cfwew-d92f04f8
FwGroupName String 防火墙名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:防火墙名称
BetaList Array of BetaInfoByACL beta任务详情
注意:此字段可能返回 null,表示取不到有效值。
ParamTemplateId String 端口协议组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:pp-1q2w3e4r
ParamTemplateName String 端口协议组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
TargetName String 访问目的名称
注意:此字段可能返回 null,表示取不到有效值。
SourceName String 访问源名称
注意:此字段可能返回 null,表示取不到有效值。

VpcZoneData

vpc区域数据详情

被如下接口引用:CreateChooseVpcs。

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