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 | 云厂商代码 示例值：云厂商代码 |
| AutoTask | String | 自动化助手信息 示例值：cmd_json |
| InstanceName | String | 实例名称 示例值：andy的cvm |
| RegionCode | String | 地域码信息 示例值：ap-guangzhou |
| Country | Integer | 国家代码 示例值：86 |
| City | Integer | 城市代码 示例值：2 |
| RegName1 | String | 国家名称 示例值：新加坡 |
| RegName2 | String | 城市名称 示例值：北京 |
AccessInstanceInfo
接入防火墙实例信息
被如下接口引用：CheckClusterNatFwPreAccess, CheckClusterVpcFwPreAccess, DescribeCcnVpcFwSwitch, DescribeNatCcnFwSwitch, ModifyClusterNatFwSwitch, ModifyClusterVpcFwSwitch, OpenClusterNatFwSwitch, UpdateClusterVpcFw。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceId | String | 是 | 实例ID 示例值：vpc-lw7v0igu |
| InstanceType | String | 是 | 实例类型VPC or DIRECTCONNECT等类型 示例值：DIRECTCONNECT |
| InstanceRegion | String | 是 | 实例所在地域 示例值：ap-seoul |
| AccessCidrMode | Integer | 是 | 接入防火墙的网段模式：0-不接入，1-接入实例关联的所有网段，2-接入用户自定义的网段 示例值：2 |
| AccessCidrList | Array of String | 是 | 接入防火墙的网段列表 示例值：["10.70.12.0/22"] |
AclRegInfo
ACL 地理位置支持地域数据
被如下接口引用：DescribeAclRegInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| RegionCode | String | 地域KEY 示例值：zd |
| RegionName | String | 地域名称 示例值：中国大陆 |
| Parent | String | 上级地域信息 示例值：R_EUROPE |
| ZhKey | String | 中文拼音首字母 示例值：A |
| EnKey | String | 英文首字母 示例值：B |
| Area | Integer | 是否为地区 示例值：1 |
| IsCity | Integer | 是否为省份、城市 示例值：0 |
| Num | Integer | 序号 示例值：1 |
| ForBypass | Integer | 是否支持旁路 示例值：1 |
| ForSerial | Integer | 是否支持串行 示例值：1 |
| ForNat | Integer | 是否支持NAT 示例值：1 |
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 |
| TkeClusterId | String | 否 | 容器服务集群ID 示例值：cls-4be80m52 |
AttachInsInfo
关联实例信息
被如下接口引用：DescribeClusterNatCcnFwSwitchList, DescribeClusterVpcFwSwitchs。
| 名称 | 类型 | 描述 |
|---|---|---|
| InsId | String | 实例对象可以是cvm类型:ins-ad21xuds1形式;路由表类型:rtb-da12daxd形式;vpc类型:vpc-1dxdad2d形式 示例值：vpc-da12daxd |
| InsName | String | 实例对象名称 示例值：生产vpc |
| Cidr | String | 实例的cidr 示例值：10.0.0.0/8 |
BanAndAllowRule
封禁或放通规则条目；各字段的校验、归一化和实际用途由 RuleType 决定。
被如下接口引用：CreateBlockIgnoreRuleNew, ModifyBlockIgnoreRuleNew。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Comment | String | 否 | 规则备注，最多 200 个字符。 示例值：生产环境放通 |
| CustomRule | CustomWhiteRule | 否 | 自定义放通规则详情。RuleType=6 时使用；其它规则类型不读取此字段。 |
| DirectionList | String | 否 | 生效方向，使用逗号分隔的整数：0 互联网出站、1 互联网入站、2 双向、3 东西向、4 情报误报反馈、5 内网访问源、6 内网访问目的。所有 RuleType 均须显式传入非空值。RuleType=6 会先校验本字段，再根据 CustomRule 重新计算最终方向；例如私网源到私网目的可传 5,6，创建后应查询确认最终方向。 示例值：0,1 |
| EndTime | String | 否 | 规则截止时间，使用北京时间（UTC+8）的 YYYY-MM-DD HH:MM:SS 格式，且不得早于服务器处理时刻；3000-01-01 00:00:00 表示长期有效。 示例值：3000-01-01 00:00:00 |
| FwType | Integer | 否 | RuleType=6 的生效引擎位图：1 互联网边界旁路、2 NAT 防火墙、4 VPC 防火墙、8 互联网边界串行、16 NDR；组合值按位相加，取值范围为 0 至 31。非零值会与源、目的地址适用的引擎取交集，并保留 NDR 位；结果为 0 时，IPv6 或私网 IPv4 地址使用 6，其它地址使用 15。其它 RuleType 不使用该字段。 示例值：1 |
| Ioc | String | 否 | 规则对象。RuleType=1 或 2 时传 IP 地址，RuleType=3 时传域名，RuleType=4 时传情报标识，RuleType=5 时使用 DescribeCfwAssets 返回的 assets[].instance_id。RuleType=6 新建时必须显式传空字符串，由服务生成规则 ID，不可省略。更新既有自定义规则时传入该规则的现有 ID。 示例值：192.0.2.10 |
BanAndAllowRuleDel
封禁或放通规则项，包含对象、适用方向和规则类型。
被如下接口引用：DeleteBlockIgnoreRuleNew。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DirectionList | String | 否 | 规则的完整适用方向列表，多个值以逗号分隔：0 互联网出站，1 互联网入站，2 双向，3 东西向，4 情报误报反馈，5 内网访问源，6 内网访问目的。通过 DescribeBlockIgnoreList 查询时传顶层 Direction=""，并使用目标 Data[].DirectionList。 示例值：0,1 |
| Ioc | String | 否 | 封禁或放通对象值。通过 DescribeBlockIgnoreList 查询并使用完全匹配目标的 Data[].Ioc。 示例值：1.2.3.4 |
| RuleType | Integer | 否 | 规则类型标识。通过 DescribeBlockIgnoreList 查询并使用目标 Data[].RuleType。常用值：1 封禁 IP，2 放通 IP，3 放通域名，4 威胁情报地址，5 资产实例，6 自定义策略，7 入侵防御规则，8 扩展 IP 规则，9 扩展自定义规则。 示例值：1 |
BetaInfoByACL
规则关联的beta任务
被如下接口引用：AddVpcAcRule, DescribeAclRule, DescribeNatAcRule, DescribeVpcAcRule, ModifyVpcAcRule。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| LastTime | String | 否 | 上次执行时间 示例值：2023-03-02 10:00:00 |
| TaskId | Integer | 否 | 任务id 示例值：1001 |
| TaskName | String | 否 | 任务名称 示例值：任务名称 |
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 | 域名 示例值：url.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 |
BlockInfo
告警中心-阻断事件结构体
被如下接口引用：DescribeBlockList。
| 名称 | 类型 | 描述 |
|---|---|---|
| SrcIP | String | 源IP 示例值：“183.45.1.2" |
| DstIP | String | 目的ip 示例值：“183.45.1.2，222.11.22.11" |
| DstPort | String | 端口 示例值：”22,80“ |
| AppID | String | appid信息 示例值：“1300448058” |
| AssetId | String | 资产id 示例值：”ins-id“ |
| AssetName | String | 资产名称 示例值：”ins-name“ |
| Zone | String | 地域 示例值：“上海” |
| MaxDate | String | 最晚时间 示例值：2021-05-25 00:00:00 |
| MinDate | String | 最近时间 示例值：2021-05-25 00:00:00 |
| Direction | Integer | 方向 1入站 0出战 示例值：1 |
| BlockSource | Integer | 来源 1拦截列表，2虚拟补丁，3威胁情报，4基础防御 示例值：1 |
| Country | String | 国加 示例值：中国 |
| Count | Integer | 次数 示例值：50 |
| AvgCount | Float | 拦截频率 示例值：0.2 |
| IsTop | Integer | 置顶位 示例值：1 |
| UniqueId | String | 记录唯一标识 示例值：uuid |
| ByPass | Integer | 1是 0不是 示例值：是否bpass |
| Block | Integer | 1是 0不是 示例值：是否加入黑名单 |
| Ignore | Integer | 1是 0不是 示例值：是否加入白名单 |
| WhiteTag | String | WhiteTag信息 示例值：WhiteTag |
| DstAssetId | String | vpc间防火墙日志，目的资产id 注意：此字段可能返回 null，表示取不到有效值。 示例值：ins-id |
| DstAssetName | String | vpc间防火墙日志，目的资产名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：ins-cvm |
| SrcVpc | String | vpc间防火墙日志，源VPC id 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-id |
| SrcVpcName | String | vpc间防火墙日志，源VPC名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-srcname |
| DstVpc | String | vpc间防火墙日志，目的VPC id 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-id |
| DstVpcName | String | vpc间防火墙日志，目的VPC名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-dstname |
| EdgeId | String | vpc间防火墙开关边id 注意：此字段可能返回 null，表示取不到有效值。 示例值：cfws-id |
| EdgeName | String | vpc间防火墙开关边名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：cfws-fwname |
| LogSource | String | 日志来源 move：vpc间防火墙 注意：此字段可能返回 null，表示取不到有效值。 示例值：move |
| Isolate | Integer | 是否加入隔离列表，1是 0不是 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Hide | Integer | 是否加入隔离列表，1是 0不是 示例值：1 |
| Domain | String | 域名 注意：此字段可能返回 null，表示取不到有效值。 示例值：域名 |
CcnAssociatedInstance
CCN关联的实例信息
被如下接口引用：DescribeCcnAssociatedInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 示例值：vpc-92gxvdf1 |
| InstanceName | String | 实例名称 示例值：策略路由测试1 |
| InsType | String | 实例类型 示例值：VPC |
| CidrLst | Array of String | 实例的网段列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["10.0.0.0/16"] |
| InstanceRegion | String | 实例所属地域 示例值：ap-guangzhou |
| IsCrossInstance | Integer | 是否跨账号 示例值：1 |
CcnSwitchInfo
ccn实例开关信息
被如下接口引用：CheckClusterVpcFwPreAccess, ModifyClusterVpcFwSwitch, UpdateClusterVpcFw。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| CcnId | String | 是 | ccn的id 注意：此字段可能返回 null，表示取不到有效值。 示例值：ccn-1dsx21ls |
| SwitchMode | Integer | 是 | 开关接入模式，1:自动接入,2:手动接入 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| RoutingMode | Integer | 否 | 引流路由方法 0:多路由表, 1:策略路由 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| RegionCidrConfigs | Array of RegionCidrConfig | 否 | 地域级别CIDR配置 |
| InterconnectPairs | Array of InterconnectPair | 否 | 互联集合对列表 |
| FwVpcCidr | String | 否 | 引流通用CIDR(废弃) 示例值：auto |
CfwInsStatus
防火墙实例运行状态
被如下接口引用：DescribeCfwInsStatus。
| 名称 | 类型 | 描述 |
|---|---|---|
| CfwInsId | String | 防火墙实例id 示例值：cfwnat-id |
| FwType | String | 防火墙类型，nat：nat防火墙；ew：vpc间防火墙 示例值：nat |
| Region | String | 实例所属地域 示例值：ap-guangzhou |
| Status | String | 实例运行状态，Running：正常运行；BypassAutoFix：bypass修复；Updating：升级中；Expand：扩容中；BypassManual：手动触发bypass中；BypassAuto：自动触发bypass中；BypassTcDrop：丢包触发bypass中 枚举值：
示例值：Running |
| EventTime | String | 事件时间 示例值：2024-11-11 11:22:22 |
| RecoverTime | String | 恢复时间 示例值：2024-11-11 11:22:22 |
| CfwInsName | String | 实例名称 示例值：cfwname |
| TrafficMode | String | Normal: 正常模式 示例值：Normal |
CfwNatDnatRule
NAT防火墙Dnat规则
被如下接口引用：CreateNatFwDnatRule, DeleteNatFwDnatRule, 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防火墙转发规则描述。 示例值：自定义描述 |
CfwStatusMonitorFilter
状态监控过滤条件。
被如下接口引用：DescribeCfwStatusMonitor。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 过滤字段名。 注意：此字段可能返回 null，表示取不到有效值。 示例值：Ip |
| Values | Array of String | 是 | 过滤值列表，最多 10 个。 注意：此字段可能返回 null，表示取不到有效值。 示例值：["1.1.1.1"] |
| OperatorType | Integer | 否 | 操作符类型，可选；仅支持后端允许的类型。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
ClusterFwPreAccessCheckItem
预接入检查项定义
被如下接口引用：CheckClusterNatFwPreAccess, CheckClusterVpcFwPreAccess。
| 名称 | 类型 | 描述 |
|---|---|---|
| Stage | String | 检查项 key，与查询接口 CheckResult.Stages[].Stage 一一对应 示例值：vpc_bandwidth_check |
| Description | String | 该检查项的展示文案，已按请求的 Language 返回中文或英文 示例值：带宽配额检查 |
ClusterFwPreAccessCheckResult
预接入检查结果，序列化后写入 cfw_gwlb_lead_switch.check_result 列
被如下接口引用：DescribeClusterNatCcnFwSwitchList, DescribeClusterVpcFwSwitchs。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | Integer | 检查状态，0：进行中，1：通过，2：失败 示例值：1 |
| CurrentStage | String | 当前/最后所处检查项。Status=1（通过）时为 done，Status=2（失败）时为失败的检查项 key，Status=0（进行中）时为正在执行的检查项 key 示例值：done |
| Stages | Array of ClusterFwPreAccessCheckStage | 逐条检查项结果列表，按执行顺序追加 |
| PolicyRouteReport | PolicyRoutePreCheckReport | 策略路由配额核算报告，仅在 Status=1（通过）时非空 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdateTime | String | 最近一次更新时间，格式：YYYY-MM-DD HH:MM:SS 示例值：2026-06-16 14:20:20 |
ClusterFwPreAccessCheckStage
单个阶段的实时检查状态
被如下接口引用：DescribeClusterNatCcnFwSwitchList, DescribeClusterVpcFwSwitchs。
| 名称 | 类型 | 描述 |
|---|---|---|
| Stage | String | 检查项 key，与发起检查接口返回的 CheckItems[].Stage 一一对应 示例值：nat_policy_route_orchestration |
| Status | Integer | 该检查项状态，0：进行中，1：通过，2：失败 示例值：2 |
| ErrorCode | String | 失败时的错误码（仅 Status=2 时有值） 示例值：LimitExceeded |
| ErrorMessage | String | 失败时的具体错误信息（仅 Status=2 时有值） 示例值：策略路由匹配规则数超限 |
ClusterSwitchDetail
集群模式防火墙开关数据详情
被如下接口引用：DescribeClusterVpcFwSwitchs。
| 名称 | 类型 | 描述 |
|---|---|---|
| InsObj | String | 实例对象可以是ccnid类型:ccn-ad21xuds形式;nat网关类型:nat-da12daxd形式;ip类型:1.1.1.1形式等 示例值：ccn-ad21xuds |
| ObjName | String | 实例对象名称 示例值：生产ccn |
| FwType | String | 防火墙类型，ew：vpc间防火墙；nat：nat防火墙；border：互联网边界防火墙 示例值：ew |
| AssetType | String | 资产类型，ccn：ccn实例类型；nat：nat网关类型 示例值：ccn |
| Region | String | 地域 示例值：ap-guangzhou |
| Status | Integer | 开关状态 示例值：0 |
| SwitchMode | Integer | 开关接入模式，1：自动接入；2，手动接入，0：未选择 示例值：0 |
| NonCluster | Integer | 实例对象是否处于非集群接入场景（主备模式） 示例值：0 |
| IpVersion | Integer | ip版本，0：ipv4；1：ipv6 示例值：0 |
| AttachIns | Array of AttachInsInfo | 关联实例 注意：此字段可能返回 null，表示取不到有效值。 |
| Endpoints | Array of EndpointInfo | 引流私有网络端点信息 注意：此字段可能返回 null，表示取不到有效值。 |
| Idpsaction | Integer | 入侵防护模式,0:观察;1:拦截;2:严格;3:关闭 示例值：1 |
| TransEnable | Integer | //透明模式开关,0:未开启,1:已开启 示例值：0 |
| Enable | Integer | 开关状态 0关闭 1开启 示例值：1 |
| RoutingMode | Integer | 路由模式：0：多路由表，1：策略路由 示例值：1 |
| IsPeer | Integer | 是否跨租户开关 1是 0不是 示例值：0 |
| PeerAppid | String | 跨租户appid 示例值：130044xxxx |
| PeerStatus | Integer | 跨租户操作状态 1不允许操作 0可以 示例值：1 |
| Bypass | Integer | Bypass状态 示例值：0 |
| Progress | String | 防火墙开关操作时的进度状态： // 开启 — 自动模式（3步） // 开启 — 手动模式（1步） // 关闭 — 自动模式（2步） // 修改 — 自动模式（3步） // 修改 — 手动模式（1步，仅 VPC 防火墙存在手动模式修改） 示例值：AUTO_OPEN_CREATING_RESOURCES |
| CheckResult | ClusterFwPreAccessCheckResult | 预检查项的结果 |
Column
日志分析的列属性
被如下接口引用：SearchLog。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 列的名字 示例值：_col0 |
| Type | String | 列的属性 示例值：json |
CommonFilter
通用的列表检索过滤选项
被如下接口引用：DescribeAclRule, DescribeClusterNatCcnFwSwitchList, DescribeClusterVpcFwSwitchs, DescribeEdgeIpSimple, DescribeEnterpriseSecurityGroupRuleList, DescribeFwEdgeIps, DescribeFwGroupInstanceInfo, DescribeIpsRuleListNew, DescribeLogs, DescribeNatAcRule, DescribeNatFwDnatRule, DescribeNatFwSwitch, DescribeVpcAcRule, DescribeVpcAclEdgeRange, DescribeVpcFwGroupSwitch, ExportLogsOffline。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| 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关系 示例值：["109.24.115.11","83.24.11.24"] |
CommonIdName
ID NAME 组合
被如下接口引用：DescribeNatFwSwitch。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | String | 资源ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：hello |
| Name | String | 资源名字 注意：此字段可能返回 null，表示取不到有效值。 示例值：world |
CommonIdNameStatus
ID NAME STATUS 组合结构
被如下接口引用：DescribeNatFwSwitch。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | String | 资源id 注意：此字段可能返回 null，表示取不到有效值。 示例值：hello |
| Name | String | 资源name 注意：此字段可能返回 null，表示取不到有效值。 示例值：world |
| Status | Integer | 状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
CreateNatRuleItem
NAT 访问控制规则参数结构。新增和修改使用相同的字段解析；字段组合按 Direction、源和目的类型与内容、Protocol、Port、ParamTemplateId、RuleAction 和 Scope 校验。
被如下接口引用：AddNatAcRule, ModifyNatAcRule。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Direction | Integer | 是 | 规则方向，JSON 整数：0 表示出站，1 表示入站；其他值被拒绝。方向决定可用的源和目的类型及协议组合。 示例值：0 |
| OrderIndex | Integer | 是 | 规则顺序。使用 -1 追加到当前方向末尾，使用正序号在对应位置插入并顺延后续规则；0 按 1 处理，其他负数及超范围值不应使用。批量新增时按 Rules 顺序依次处理。 示例值：1 |
| Port | String | 是 | 目的端口字符串。支持逗号分隔的单端口或以斜杠分隔的起止范围，例如 80、80,443、80/443；-1/-1 表示全部端口。单端口必须是大于 0 的整数；范围只要求两个端点均为整数且起点不大于终点。Protocol 归一化为 ICMP 时忽略该字段并保存为空字符串；FTP 只接受单端口，不接受逗号列表或斜杠范围。 示例值：-1/-1 |
| Protocol | String | 是 | 协议，大小写不敏感并归一化为大写。四层值为 TCP、UDP、ICMP、ICMPV6、ANY；应用层值为 HTTP、HTTPS、HTTP/HTTPS、TLS/SSL、SMTP、SMTPS、SMTP/SMTPS、FTP、DNS，其中 domain、tls、ssl 也归一化为 TLS/SSL；ANY 表示不限定协议，不表示省略 Protocol；它同时可按四层协议和应用协议解析。入站仅允许 ANY、TCP、UDP；domain 目的及解析为域名模板的 template 目的接受上述应用层协议及 ANY，但不接受 FTP；dnsparse 和 domainiptwoverify 目的仅允许 TCP 或 UDP；其他目的不接受 FTP 和 ANY 之外的应用层协议。Protocol=DNS 且目的不是域名模板或单独的 * 时，目的列表只能包含域名，不能包含 IP。 示例值：TCP |
| RuleAction | String | 是 | 流量处理方式，大小写不敏感：accept 表示放行，drop 表示拒绝，log 表示观察；isolateinaccept 表示放行访问隔离资产的白名单流量，isolateindrop 表示阻断访问隔离资产的其它流量，isolateoutaccept 表示放行隔离资产访问白名单目标，isolateoutdrop 表示阻断隔离资产访问其它目标。 示例值：accept |
| SourceContent | String | 是 | 访问源内容，格式由 SourceType 和 Direction 决定。net/ip 使用合法 IP 或 CIDR 的逗号列表，最多 10 项；location 使用地域 code，空字符串表示全部地域；vendor 使用 tencent、aliyun、aws、huawei、azure 或 all，可用逗号分隔；template 使用地址模板 ID；instance 使用资产实例 ID；group 使用资源组 ID；tag 使用 JSON 字符串 {"Key":"标签键","Value":"标签值"}，Key 和 Value 大小写固定。 示例值：192.168.0.2 |
| SourceType | String | 是 | 访问源类型，大小写不敏感。net、ip 均表示 IP/CIDR，template 表示地址模板，instance 表示资产实例，group 表示资产分组，tag 表示资源标签，location 表示地域，vendor 表示云厂商。入站支持 net、ip、template、location、vendor；出站支持 net、ip、template、instance、group、tag。 示例值：ip |
| TargetContent | String | 是 | 访问目的内容，格式由 TargetType 和 Direction 决定。net/ip 使用合法 IP 或 CIDR 的逗号列表；domain 使用合法域名或 IP 的逗号列表，也接受单独的 ，泛域名最多 5 级，段内通配域名要求当前环境支持对应能力；dnsparse 使用单个精确域名、最多 5 级的标准泛域名或相应域名模板，不接受单独的 *、段内通配域名、IP 或逗号列表；domainiptwoverify 使用单个精确域名或不含通配符的相应域名模板，不接受单独的 *、任何通配域名、IP 或逗号列表；location 使用地域 code，空字符串表示全部地域；vendor 使用 tencent、aliyun、aws、huawei、azure 或 all，可用逗号分隔；template 使用地址模板 ID；instance 使用资产实例 ID；group 使用资源组 ID；tag 使用 JSON 字符串 {"Key":"标签键","Value":"标签值"}，Key 和 Value 大小写固定。规范化后的目的内容最长 1023 字节；IP 或 domain 目的最多包含 10 项。 示例值：.qq.com |
| TargetType | String | 是 | 访问目的类型，大小写不敏感。net、ip 均表示 IP/CIDR，template 表示地址模板，instance 表示资产实例，group 表示资产分组，tag 表示资源标签，location 表示地域，vendor 表示云厂商，domain 表示 FQDN 匹配（内容也可传 IP 或 *），dnsparse 表示宽松匹配：Host/SNI 与域名匹配，或目的 IP 属于该域名当前 DNS 解析结果，满足任一条件即命中；domainiptwoverify 表示严格匹配：上述两个条件必须同时满足。入站支持 net、ip、template、instance、group、tag；出站支持 net、ip、template、domain、dnsparse、domainiptwoverify、location、vendor。template 按模板实际类型处理，入站不接受域名模板；部分域名模式要求当前环境支持对应能力。 示例值：domain |
| Description | String | 否 | 规则描述，不超过 100 个字符。新增时按请求值保存；修改时完整替换，不继承旧值。 示例值：自定义描述 |
| Enable | String | 否 | 规则状态。字符串 true 表示启用，false 表示禁用，大小写不敏感。省略或传空字符串时读取当前账号的访问控制规则默认状态；配置不存在或无法解析时默认为启用。 示例值：true |
| InternalUuid | Integer | 否 | 覆盖导入规则标识。仅 From=batch_import_cover 接受正整数值；其它新增方式和修改请求忽略该字段。 示例值：8888 |
| ParamTemplateId | String | 否 | 端口协议模板 ID。省略或传空字符串时使用 Protocol 和 Port；非空时必须指向当前账号已有的模板，模板条目须满足协议与目的类型的联动限制。使用模板时，Protocol 仍须有效；Protocol 不是 ICMP 时，Port 也须有效，但二者不要求固定为 ANY 和 -1/-1。 示例值：pp-1q2w3e4r |
| Scope | String | 否 | 规则生效范围，值中不能含空白字符。ALL 表示全部 NAT 实例；地域 ID（如 ap-guangzhou）表示地域范围；cfwnat- 或 nat- 开头的实例 ID 表示实例范围。非空值必须是已知地域或当前账号已有的 NAT 实例。省略或传空字符串时，有请求 Region 则使用 Region，否则归一化为 ALL。 示例值：ap-guangzhou |
| Uuid | Integer | 否 | 规则 ID。普通新增、insert_rule 和 batch_import 忽略该字段；batch_import_cover 可使用正整数 ID。修改时必须提供当前账号已有且可修改的正整数 ID，并以请求中的完整字段替换该规则，同时保留并返回同一 Uuid；省略、0 或负值无法定位修改目标。 示例值：8888 |
CreateRuleItem
互联网边界访问控制规则的完整内容，供新增和修改共用。新增时缺省值按各字段说明处理；修改时完整替换可写内容，省略的可写字段不继承旧值，系统管理字段不受影响。
被如下接口引用：AddAclRule, ModifyAclRule。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Direction | Integer | 是 | 规则方向：1 表示入站，0 表示出站；其它整数或省略会校验失败。方向还决定 SourceType、TargetType、Scope 与 Protocol 的可用组合。 示例值：0 |
| OrderIndex | Integer | 是 | 规则顺序，必须填写。传 -1 时追加到当前方向末尾；正序号表示在对应位置插入并顺延后续规则；0 按 1 处理，其他负数及超范围值不应使用。新增请求包含多条规则时，Direction 必须相同；追加时全部传 -1，插入时按请求顺序传连续递增的正序号。修改请求只接受一条规则。 示例值：1 |
| Port | String | 是 | 目的端口。Protocol 为 ICMP 时忽略本字段并置为空字符串；其它协议必须提供可解析字符串，可按逗号分隔填写正整数单端口或“起始/结束”范围，起始值不得大于结束值，-1/-1 表示全部端口。FTP 只接受单个正整数。domain 或域名模板目的在 side 或 all 范围下仅接受 -1/-1 或 0/65535。 示例值：-1/-1 |
| Protocol | String | 是 | 协议，解析不区分大小写。四层值 TCP、UDP、ICMP、ICMPV6、ANY 归一化为大写；应用层值 HTTP、HTTPS、HTTP/HTTPS、SMTP、SMTPS、SMTP/SMTPS、FTP、DNS、TLS/SSL 及别名 domain、TLS、SSL 归一化为对应标准值。ANY 表示不限定协议，不表示省略 Protocol；它同时属于可解析的四层协议和应用协议，domain、TLS、SSL 均归一化为 TLS/SSL。domain 或域名模板目的接受上述应用层协议及 ANY，但不接受 FTP 和其它四层协议；dnsparse、domainiptwoverify 仅接受 TCP 或 UDP 且仅支持 serial；其它目的在公有云环境不接受 FTP、ANY 之外的应用层协议。side 或 all 范围下，入站仅接受 TCP，出站仅接受 TCP、HTTP/HTTPS 或 TLS/SSL。DNS 用于非 domain 目的且目的不是 * 时，目的内容还必须是非 IP 的合法域名规则列表。使用协议端口模板时，模板中的每组协议和端口也执行这些联动校验。 示例值：TCP |
| RuleAction | String | 是 | 流量处理动作，解析不区分大小写。accept 表示放行，drop 表示拒绝，log 表示观察；isolateinaccept 表示放行访问隔离资产的白名单流量，isolateindrop 表示阻断访问隔离资产的其它流量，isolateoutaccept 表示放行隔离资产访问白名单目标，isolateoutdrop 表示阻断隔离资产访问其它目标。drop 及其拒绝别名还会校验当前账号是否具备互联网边界阻断能力。 示例值：accept |
| SourceContent | String | 是 | 访问源内容。ip 或 net 使用合法 IP/CIDR 列表，普通列表最多 10 项；template 使用当前账号可解析的地址模板标识；Direction=0 时，instance、group、tag 使用相应资源标识，其中 instance 必须能解析到公网 IP，tag 必须存在且格式为 {"Key":"标签键","Value":"标签值"}；Direction=1 时，location 使用地域 code CSV 并须通过当前账号的新地域规则能力校验，vendor 使用 tencent、aliyun、aws、huawei、azure 或 all 的 CSV。location、vendor 保存时会转换为地域或厂商匹配信息。 示例值：192.168.0.2 |
| SourceType | String | 是 | 访问源类型，解析不区分大小写。net、ip 均表示 IP/CIDR，template 表示地址模板，instance 表示资产实例，group 表示资产分组，tag 表示资源标签，location 表示地域，vendor 表示云厂商。Direction=1 接受 ip、net、template、location、vendor；Direction=0 接受 ip、net、template、instance、group、tag。ip 与 net 按同一类型处理。 示例值：ip |
| TargetContent | String | 是 | 访问目的内容。ip 或 net 使用合法 IP/CIDR 列表；domain 使用合法的 IP、普通域名或通配域名列表，也接受单独的 ；普通列表最多 10 项，通配域名最多 5 级。domain 配合 DNS 协议时不接受 IP。dnsparse 使用单个合法域名、泛域名或当前账号可解析的 mb_ 域名模板，domainiptwoverify 使用单个不含通配符的合法域名或此类模板；两者均不接受单独的 *、IP、逗号列表或段内通配域名。串行 domain 段内通配和 domainiptwoverify 模板要求当前环境支持对应能力。template 使用当前账号可解析的地址模板标识；Direction=1 时，instance、group、tag 使用相应资源标识，其中 instance 必须能解析到公网 IP，tag 必须存在且格式为 {"Key":"标签键","Value":"标签值"}；Direction=0 时，location 使用地域 code CSV，vendor 使用 tencent、aliyun、aws、huawei、azure 或 all 的 CSV。规范化后的内容最长 1023。 示例值：.qq.com |
| TargetType | String | 是 | 访问目的类型，解析不区分大小写。net、ip 均表示 IP/CIDR，template 表示地址模板，instance 表示资产实例，group 表示资产分组，tag 表示资源标签，location 表示地域，vendor 表示云厂商，domain 表示 FQDN 匹配（内容也可传 IP 或 *），dnsparse 表示宽松匹配：Host/SNI 与域名匹配，或目的 IP 属于该域名当前 DNS 解析结果，满足任一条件即命中；domainiptwoverify 表示严格匹配：上述两个条件必须同时满足。Direction=1 接受 ip、net、template、domain、instance、group、tag；Direction=0 接受 ip、net、template、domain、dnsparse、domainiptwoverify、location、vendor。 示例值：domain |
| Description | String | 否 | 规则描述，不超过 100 个字符。新增时按请求值保存；修改时完整替换，不继承旧值。 示例值：自定义描述 |
| Enable | String | 否 | 启用状态。非空值不区分大小写接受字符串 true 或 false，并归一化为启用或停用；省略或传空字符串时读取当前账号的访问控制默认启用配置，该配置不可用时默认启用。替换现有规则时不继承旧值。 示例值：true |
| LogId | String | 否 | 关联告警或来源事件 ID。新增时省略或传空字符串表示不关联；修改时应将 DescribeCfwRules 返回的 rules[].log_id 原样传入，未返回时省略或传空字符串。替换时不会自动继承旧值；From=batch_import_cover 时，非空值还会作为覆盖导入后规则的字符串标识复用。 示例值：987c1bb3-f975-4055-a0f9-40beab3633da |
| ParamTemplateId | String | 否 | 协议端口模板 ID。省略或传空字符串表示不使用模板；非空时必须指向当前账号已有且内容格式为“协议:端口”的模板，否则请求失败。模板中的协议和端口须满足 Direction、TargetType 与 Scope 的联动限制。Protocol 和 Port 仍须符合各自字段规则，但不要求固定填写 ANY、-1/-1 或 serial。 示例值：pp-1q2w3e4r |
| RuleSource | Integer | 否 | 规则来源：0 表示普通规则，2 表示隔离资产出向访问规则。新增时可以省略，省略按 0 处理；显式传值及修改时仅接受 0 或 2，修改时应传入原规则值。 示例值：0 |
| Scope | String | 否 | 生效范围，解析不区分大小写：serial 表示仅互联网边界串行防火墙，side 表示仅互联网边界旁路防火墙，all 表示同时作用于串行和旁路防火墙；省略、空字符串或其它值会校验失败。国际站环境会将有效输入统一归一化为 serial。协议、端口、目的类型及协议端口模板的联动限制见 Protocol、Port 和 ParamTemplateId。 示例值：serial |
| Uuid | Integer | 否 | 规则数值 ID。普通新增、指定位置新增和批量导入会忽略该字段；From=batch_import_cover 时可使用正整数 ID；修改时必须提供当前账号已有且可修改的正整数 ID，用于定位并完整替换原规则，省略、非正整数或不存在的 ID 会导致请求失败。 示例值：8888 |
CustomWhiteRule
RuleType=6 使用的自定义放通规则详情。SrcIP、DstIP 至少一项必须是具体 IP；另一项可省略或使用与具体 IP 同版本的通配网段 0.0.0.0/0、::/0。两项均为具体 IP 时，当前处理器拒绝源 IPv6、目的 IPv4 的组合；源 IPv4、目的 IPv6 的反向组合当前不受该版本检查限制。资产判定中，私网 IPv4 和任意 IPv6 直接通过，公网 IPv4 必须存在于当前账号 cfw_public_ip。两项均为具体 IP 时至少一项须通过资产判定；仅一项为具体 IP 且另一项省略或为同版本通配网段时，若实际 FwType 包含互联网边界位 1，该具体 IP 也必须通过资产判定。处理器据此计算规则方向和适用引擎。
被如下接口引用：CreateBlockIgnoreRuleNew, DescribeBlockIgnoreList, ModifyBlockIgnoreRuleNew。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DstIP | String | 否 | 自定义规则的目的地址。SrcIP、DstIP 至少一项必须是具体 IP；本字段仅在 SrcIP 为具体 IP 时可省略或使用与 SrcIP 同版本的通配网段。两项均为具体 IP 时，源 IPv6、目的 IPv4 会被拒绝，源 IPv4、目的 IPv6 当前不受该版本检查限制。私网 IPv4 和任意 IPv6 直接通过资产判定，公网 IPv4 必须存在于当前账号 cfw_public_ip；是否要求通过资产判定由两侧地址与实际 FwType 联动决定。 示例值：10.0.0.12 |
| IdsRuleId | String | 否 | 自定义规则关联的入侵防御规则 ID。调用 DescribeIpsRuleListNew，传目标规则的查询条件，仅使用 Data[].RuleID；该值必须可转换为整数且对应现有入侵防御规则。 示例值：20001 |
| IdsRuleName | String | 否 | 自定义规则名称；处理器不对内容做额外校验。 示例值：自定义规则名称 |
| SrcIP | String | 否 | 自定义规则的源地址。SrcIP、DstIP 至少一项必须是具体 IP；本字段仅在 DstIP 为具体 IP 时可省略或使用与 DstIP 同版本的通配网段。两项均为具体 IP 时，源 IPv6、目的 IPv4 会被拒绝，源 IPv4、目的 IPv6 当前不受该版本检查限制。私网 IPv4 和任意 IPv6 直接通过资产判定，公网 IPv4 必须存在于当前账号 cfw_public_ip；是否要求通过资产判定由两侧地址与实际 FwType 联动决定。 示例值：10.0.0.11 |
DatabaseWhiteListRuleData
数据库白名单规则数据
被如下接口引用：CreateDatabaseWhiteListRules。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SourceIp | String | 是 | 访问源 示例值：192.177.54.82 |
| SourceType | Integer | 是 | 访问源类型，1 ip；6 实例；100 资源分组 示例值：1 |
| TargetIp | String | 是 | 访问目的 示例值：cdb-id |
| 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 | 关联任务详情 |
| 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 |
| CountryKey | String | 地区简称 示例值：zd |
| CityKey | String | 省份、城市简称 示例值：hn43 |
| CreateTime | String | 规则创建时间 示例值：2025-07-24 00:00:00 |
| UpdateTime | String | 规则最近更新时间 示例值：2025-07-24 01:00:00 |
| DestValueType | String | 目的值的类型，与TargetType或DestType所代表的目的类型含义有所不同，如目的类型是template,但template分ip模板和域名模板，故需通过DestValueType进一步区分 示例值：domain,net,template |
| RulePartition | Integer | 规则分区，1最前分区，2中间分区，3最后分区 |
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.112 |
| PrivatePort | Integer | 内网端口。 示例值：80 |
| Description | String | NAT防火墙转发规则描述。 示例值：自定义描述 |
| IsReferenced | Integer | 是否被关联引用，如被远程运维使用 示例值：0 |
| FwInsId | String | 所属防火墙实例id 示例值：cfwnat-id |
| NatGwId | String | 关联的nat网关Id 示例值：natgw-id |
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-d1da23dx |
| 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: 该用户已在该地域配置串行带宽，可以开启串行开关 3. 该地域可以支持串行，但是未部署公共集群 示例值：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.qq.com |
| OverUsedStatus | Integer | IP超量状态 示例值：0 |
| SwitchSupportType | Integer | 0 都不支持 1 支持旁路 2 支持串行 3 旁路串行都支持 示例值：3 |
EdgeIpInfoSimple
边界防火墙公网IP开关列表
被如下接口引用：DescribeEdgeIpSimple。
| 名称 | 类型 | 描述 |
|---|---|---|
| PublicIp | String | 公网IP 示例值：124.156.218.153 |
| PublicIpType | Integer | 公网 IP 类型 1 公网,2 弹性,3 弹性ipv6,4 anycastIP, 6 HighQualityEIP 示例值：1 |
| InstanceId | String | 实例ID 示例值：ins-ighogubo |
| InstanceName | String | 实例名 示例值：test123 |
| Status | Integer | 开关状态 0 : 关闭 1 : 开启 2 : 开启中 3 : 关闭中 4 : 异常 示例值：1 |
| SwitchMode | Integer | 0 : 旁路 1 : 串行 2 : 正在模式切换 示例值：1 |
| Region | String | 地域 示例值：ap-shanghai |
| AssetType | String | 资产类型 示例值：CLB |
EdgeIpSwitch
开启、关闭 防火墙互联网边界开关
被如下接口引用：ModifyEdgeIpSwitch。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PublicIp | String | 是 | 公网IP 示例值：1.1.1.1 |
| SubnetId | String | 否 | vpc 中第一个EIP开关打开，需要指定子网创建私有连接 示例值：subnet-1da3s2xd |
| EndpointIp | String | 否 | 创建私有连接指定IP 示例值：10.1.1.1 |
| SwitchMode | Integer | 否 | 0 : 旁路 1 : 串行 示例值：1 |
EdgeRange
vpc间防火墙规则生效范围列表
被如下接口引用：DescribeVpcAclEdgeRange。
| 名称 | 类型 | 描述 |
|---|---|---|
| EdgeId | String | 规则生效的范围id，是在哪对vpc之间还是针对所有vpc间生效 示例值：cfws-d323dadb |
| EdgeName | String | EdgeId对应的名称 示例值：生产edge |
| SrcId | String | 本端网络实例Id 示例值：vpc-1dsxd3dx |
| SrcRegion | String | 本端网络实例所属地域 示例值：ap-shanghai |
| SrcName | String | 本端网络实例名称 示例值：源生产vpc |
| SrcCidr | String | 本端网络实例cidr，多个以逗号分隔 示例值：192.168.0.0/24 |
| DstId | String | 对端网络实例Id 示例值：vpc-dsa1cx3 |
| DstRegion | String | 对端网络实例所属地域 示例值：ap-beijing |
| DstName | String | 对端网络实例名称 示例值：目的生产vpc |
| DstCidr | String | 对端网络实例cidr，多个以逗号分隔 示例值：172.16.0.0/24 |
EndpointInfo
私有连接端点信息
被如下接口引用：DescribeClusterNatCcnFwSwitchList, DescribeClusterVpcFwSwitchs。
| 名称 | 类型 | 描述 |
|---|---|---|
| EndpointId | String | 引流私有连接端点id 示例值：vpce-hafs122d |
| VpcId | String | 引流VpcId 示例值：vpc-xmds2ds3 |
| Region | String | 所属地域 示例值：ap-guangzhou |
| VpcCidr | String | 引流Vpc的Cidr 示例值：10.199.0.0/26 |
EnterpriseSecurityGroupRuleBetaInfo
企业安全组自动化任务信息
被如下接口引用：DescribeEnterpriseSecurityGroupRuleList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TaskId | Integer | 否 | 任务id 示例值：9001 |
| TaskName | String | 否 | 任务名称 示例值：自动化任务 |
| 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实例(instance) 2表示子网实例(instance) 3表示CVM实例(instance) 4表示CLB实例(instance) 5表示ENI实例(instance) 6表示数据库实例(instance) 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实例(instance) 2表示子网实例(instance) 3表示CVM实例(instance) 4表示CLB实例(instance) 5表示ENI实例(instance) 6表示数据库实例(instance) 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 | 自动化任务信息 |
| Id | Integer | 规则id 等同RuleUuid 示例值：1 |
| DnsParseCount | SgDnsParseCount | 域名解析的IP统计 |
| CreateTime | String | 规则创建时间 示例值：2025-07-24 00:00:00 |
| UpdateTime | String | 规则最近更新时间 示例值：2025-07-24 01:00:00 |
| RulePartition | Integer | 规则分区，1最前分区，2中间分区，3最后分区 示例值：2 |
| Scope | String | 规则生效范围，SG安全组，LH轻量服务器 示例值：SG |
FieldOption
字段可选项枚举值
被如下接口引用：DescribeNDRAssetIdentificationList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Text | String | 字段展示值 示例值：广州 |
| Value | String | 字段存储值 示例值：ap-guangzhou |
FilterDataObject
查询下拉选择选项数据
被如下接口引用：DescribeClusterNatCcnFwSwitchList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Text | String | 显示名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：上海 |
| Value | String | 实际值 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-shanghai |
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-dxd31akg |
FwGateway
防火墙引流网关信息
被如下接口引用：DescribeFwGroupInstanceInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| GatewayId | String | 是 | 防火墙网关id 示例值：havip-85becc |
| VpcId | String | 是 | 网关所属vpc id 示例值：vpc-a59a64 |
| IpAddress | String | 是 | 网关ip地址 示例值：192.168.1.1/24 |
FwGroupIdName
防火墙(组)ID 和 名称
被如下接口引用：DescribeFwGroupIdNames。
| 名称 | 类型 | 描述 |
|---|---|---|
| FwGroupId | String | 防火墙(组)ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cfwg-1i71wz |
| FwGroupName | String | 防火墙(组)名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：fwGroup |
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-wecrvtb |
| SwitchName | String | 防火墙开关NAME 示例值：vpc开关 |
| 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-kwuw05al |
| FwCidr | String | 是 | 防火墙网段，最少/24的网段 示例值：192.168.0.0/24 |
IPDefendStatus
ip防护状态
被如下接口引用：DescribeIPStatusList。
| 名称 | 类型 | 描述 |
|---|---|---|
| IP | String | ip地址 示例值：1.2.3.4 |
| Status | Integer | 防护状态 1:防护打开; -1:地址错误; 其他:未防护 示例值：1 |
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 |
IntArray
用于构造二维数组
被如下接口引用：DescribeLogStorageStatistic。
| 名称 | 类型 | 描述 |
|---|---|---|
| List | Array of Integer | 数组 注意：此字段可能返回 null，表示取不到有效值。 示例值：[1000,10001] |
InterconnectPair
接入防火墙的互联集合对
被如下接口引用：CheckClusterVpcFwPreAccess, DescribeCcnVpcFwSwitch, ModifyClusterVpcFwSwitch, UpdateClusterVpcFw。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| GroupA | Array of AccessInstanceInfo | 是 | 集合A |
| GroupB | Array of AccessInstanceInfo | 是 | 集合B |
| InterconnectMode | String | 是 | 互联模式："CrossConnect": 交叉互联（组A内每个实例和组B内每个实例互联），"FullMesh": 全互联（组A实际和组B内容一致，相当于组内两两互联） 示例值：FullMesh |
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 |
IpsRuleDetailNew
IPS规则展示字段相关结构
被如下接口引用：DescribeIpsRuleListNew。
| 名称 | 类型 | 描述 |
|---|
LogInfo
日志结果信息
被如下接口引用：SearchLog。
| 名称 | 类型 | 描述 |
|---|---|---|
| Time | Integer | 日志时间，单位ms 示例值：1619162953000 |
| TopicId | String | 日志主题ID 示例值：cfw_netflow_border |
| TopicName | String | 日志主题名称 示例值：业务A日志主题 |
| Source | String | 日志来源IP 示例值：10.0.0.1 |
| FileName | String | 日志文件名称 示例值：/test/access.log |
| PkgId | String | 日志上报请求包的ID 示例值：0 |
| PkgLogId | String | 请求包内日志的ID 示例值：0 |
| LogJson | String | 日志内容的Json序列化字符串 注意：此字段可能返回 null，表示取不到有效值。 示例值：{\"content\":\"test\"} |
| HostName | String | 日志来源主机名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：hostName-1 |
| RawLog | String | 原始日志(仅在日志创建索引异常时有值) 注意：此字段可能返回 null，表示取不到有效值。 示例值：{\"content\":\"test\"} |
| IndexStatus | String | 日志创建索引异常原因(仅在日志创建索引异常时有值) 注意：此字段可能返回 null，表示取不到有效值。 示例值：IndexAllFail:fields like 'a' and 'a.b' can not appear in the same topic |
LogItem
日志中的KV对
被如下接口引用：SearchLog。
| 名称 | 类型 | 描述 |
|---|---|---|
| Key | String | 日志Key 示例值：http_code |
| Value | String | 日志Value 示例值：200 |
LogItems
LogItem的数组
被如下接口引用：SearchLog。
| 名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of LogItem | 分析结果返回的KV数据对 |
ModeInfo
入侵防御防护模式相关
被如下接口引用：DescribeIpsModeSwitch。
| 名称 | 类型 | 描述 |
|---|---|---|
| Mode | Integer | 0-观察模式, 1-拦截模式, 2-严格模式 示例值：0 |
MultiTopicSearchInformation
多日志主题检索相关信息
被如下接口引用：SearchLog。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TopicId | String | 否 | 要检索分析的日志主题ID 示例值：682d0718-07bb-4ec0-xxxx-f1e9a2767e0b |
| Context | String | 否 | 透传上次接口返回的Context值，可获取后续更多日志，总计最多可获取1万条原始日志，过期时间1小时 示例值：Y29udGV4dC04MjMzNWRkMi01YmMxLTQ4NGYtYjQ4MS04MDg0NzAwYjQ1NDUxNjcy |
NDRAssetCategoryStats
NDR资产识别服务类型统计结果
被如下接口引用：DescribeNDRAssetIdentificationList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 服务类型 示例值：Web |
| Services | Array of NDRAssetServiceStats | 服务统计结果 |
NDRAssetServiceInfo
NDR资产识别信息
被如下接口引用：DescribeNDRAssetIdentificationCursorList, DescribeNDRAssetIdentificationList。
| 名称 | 类型 | 描述 |
|---|---|---|
| AssetId | String | 资产ID 示例值：9154555129771386479 |
| InstanceId | String | 实例ID 示例值：ins-jjr1tew0 |
| InstanceName | String | 实例名称 示例值：as-tke-np-po75qvbq1 |
| InstanceType | String | 实例类型 示例值：CVM |
| Region | String | 地域 示例值：ap-guangzhou |
| VpcId | String | 私有网络ID 示例值：vpc-39sc6ru5 |
| VpcName | String | 私有网络名称 示例值：test |
| Ip | String | 服务IP 示例值：10.116.101.29 |
| Port | Integer | 服务端口 示例值：8000 |
| IpVersion | String | IP版本 "0": IPv4 "1": IPv6 示例值：0 |
| IpType | String | IP类型 "0": 公网IP "1": EIP "-1": 内网IP 示例值：0 |
| AssetService | String | 服务名称 示例值：Nginx |
| AssetVersion | String | 服务版本 示例值：1.0.0 |
| AssetCategory | String | 服务类型 示例值：Web |
| Protocol | String | 协议 示例值：HTTP |
| IdentificationSource | String | 识别来源 "0": 流量识别 "1": 云资产实例 示例值：0 |
| FirstIdentificationTime | String | 首次识别时间 示例值：2025-03-11 19:23:49 |
| LatestIdentificationTime | String | 最近识别时间 示例值：2025-03-11 19:45:49 |
| ServerAddr | String | 服务地址 示例值：10.116.101.29:8000 |
NDRAssetServiceStats
NDR资产服务统计结果
被如下接口引用：DescribeNDRAssetIdentificationList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 服务名称 示例值：HTTP |
| Count | Integer | 服务计数 示例值：5 |
NatCcnSwitchConfig
NAT CCN防火墙开关配置
被如下接口引用：CheckClusterNatFwPreAccess, ModifyClusterNatFwSwitch, OpenClusterNatFwSwitch。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NatInsId | String | 是 | NAT防火墙实例ID 示例值：cfwnat-xxxxxxxx |
| CcnId | String | 是 | 云联网实例ID 示例值：ccn-xxxxxxxx |
| SwitchMode | Integer | 是 | 开关接入模式，1:自动接入，2:手动接入 示例值：1 |
| RoutingMode | Integer | 是 | 引流路由方法，0:多路由表，1:策略路由。自动接入模式仅支持策略路由(1)；手动接入模式支持多路由表(0)和策略路由(1) 示例值：1 |
| AccessInstanceList | Array of AccessInstanceInfo | 否 | 接入的实例列表 |
| LeadVpcCidr | String | 否 | 引流VPC的CIDR网段 示例值：10.18.0.0/26 |
NatClusterInfo
NAT集群模式开关信息
被如下接口引用：DescribeNatFwInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NatInsId | String | 否 | nat网关ID 示例值：nat-45yn1tks |
| NatInsName | String | 否 | nat网关名称 示例值：**NAT测试 |
NatClusterRegionStatusQuery
NAT集群防火墙地域部署状态查询
被如下接口引用：DescribeNatFwClusterRegionStatus。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| CcnId | String | 是 | 云联网ID 示例值：ccn-c0qmm031 |
| NatInsId | String | 是 | NAT网关ID 示例值：nat-45yn1tks |
| AssetType | String | 是 | 资产类型，取值：nat_ccn-CCN+NAT场景，nat-独立NAT场景 示例值：nat_ccn |
| RoutingMode | Integer | 否 | 引流路由方法，0-多路由表模式，1-策略路由模式 示例值：1 |
NatFwClusterRegionStatus
NAT防火墙引流集群地域状态
被如下接口引用：DescribeNatFwClusterRegionStatus。
| 名称 | 类型 | 描述 |
|---|---|---|
| NatInsId | String | NAT网关ID 示例值：nat-**** |
| CcnId | String | 云联网ID 示例值：ccn-**** |
| Region | String | 地域，如 ap-guangzhou 示例值：eu-frankfurt |
| Status | String | 地域集群状态，取值： 示例值：Auto |
| Cidr | String | 引流网络 CIDR，仅当 Status 为 Auto 或 Custom 时有值 示例值：10.173.7.128/26 |
| RoutingMode | Integer | 引流路由方法，0-多路由表模式，1-策略路由模式 示例值：0 |
NatFwEipsInfo
Nat防火墙弹性公网ip列表
被如下接口引用：DescribeCfwEips。
| 名称 | 类型 | 描述 |
|---|---|---|
| Eip | String | 弹性公网ip 示例值：175.27.187.125 |
| NatGatewayId | String | 所属的Nat网关Id 示例值：nat-7cq345j4 |
| NatGatewayName | String | Nat网关名称 示例值：NAT网关 |
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 |
NatFwSwitchDetailS
NAT防火墙开关详情
被如下接口引用：DescribeClusterNatCcnFwSwitchList。
| 名称 | 类型 | 描述 |
|---|---|---|
| InsObj | String | NAT实例ID 示例值：nat-jj0evrti |
| ObjName | String | 实例名称 示例值：test-nat-fw |
| FwType | String | 防火墙类型 示例值：nat |
| AssetType | String | 资产类型，nat-VPC内防护，nat_ccn-CCN集群模式 示例值：nat_ccn |
| Region | String | 地域 示例值：ap-guangzhou |
| SwitchMode | Integer | 开关接入模式，1-自动接入，2-手动接入 示例值：1 |
| RoutingMode | Integer | 引流路由方法，0-多路由表，1-策略路由 示例值：1 |
| Status | Integer | 开关状态，0-未开启，1-已开启，2-开启中，3-关闭中 示例值：1 |
| IpVersion | Integer | ip版本，0：ipv4；1：ipv6 示例值：0 |
| NonCluster | Integer | 是否非集群模式，0-集群模式，1-非集群模式 示例值：0 |
| IpsAction | Integer | 入侵防御动作 示例值：0 |
| TransEnable | Integer | 流量监控开关 示例值：0 |
| Bypass | Integer | Bypass状态，0-关闭，1-开启 示例值：0 |
| AttachId | String | 关联ID，nat_ccn资产类型时为云联网实例ID, nat资产类型时为空 示例值：ccn-xxxxxxxx |
| AttachName | String | 关联ID的实例名称，nat_ccn资产类型时为云联网名称 示例值：gwlb-nat测试--勿动--法兰克福 |
| NatVpcId | String | NAT防火墙所在VPC ID 示例值：vpc-xxxxxxxx |
| NatVpcName | String | NAT防火墙所在VPC的VPC名称 示例值：NAT网关测试-法兰克福-VPC51 |
| AttachIns | Array of AttachInsInfo | CCN关联实例列表 注意：此字段可能返回 null，表示取不到有效值。 |
| Endpoints | Array of EndpointInfo | 终端节点列表 注意：此字段可能返回 null，表示取不到有效值。 |
| Progress | String | 防火墙开关操作时的进度状态： // 开启 — 自动模式（3步） // 开启 — 手动模式（1步） // 关闭 — 自动模式（2步） // 修改 — 自动模式（3步） // 修改 — 手动模式（1步，仅 VPC 防火墙存在手动模式修改） 示例值：AUTO_CLOSE_DELETING_ROUTES |
| CheckResult | ClusterFwPreAccessCheckResult | 预接入检查结果 |
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 | 弹性开关 示例值：0 |
| ElasticBandwidth | Integer | 弹性带宽，单位Mbps 示例值：100 |
| IsFirstAfterPay | Integer | 是否首次开通按量付费 示例值：1 |
| ElasticTrafficSwitch | Integer | 按流量弹性开关 默认值：0 示例值：1 |
NatSwitchListData
NAT防火墙开关列表数据
被如下接口引用：DescribeNatFwSwitch。
| 名称 | 类型 | 描述 |
|---|---|---|
| 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，表示取不到有效值。 示例值：nat-f3kjufpn |
| NatInsName | String | NAT防火墙实例名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：NAT防火墙 |
| Region | String | 地域 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-guangzhou |
| Abnormal | Integer | 开关是否异常,0:正常,1:异常 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| ORTableId | String | nat防火墙出口路由表id 注意：此字段可能返回 null，表示取不到有效值。 示例值：rtb-bjvuftia |
| ORTableName | String | nat防火墙出口路由表名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：出口路由 |
| Ohavips | Array of String | 出口Snat Ip列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["1.1.1.1"] |
NetInstancesInfo
网络实例信息
被如下接口引用：DescribeVpcFwGroupSwitch。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 网络实例ID 示例值：vpc-bjvuftia |
| 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 |
OfflineExportTask
离线导出任务
被如下接口引用：DescribeOfflineExportTask。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务ID 示例值：1000 |
| TaskName | String | 任务名称 示例值：导出流量日志 |
| CreateTime | String | 创建时间 示例值：2023-01-01 00:00:00 |
| DataLength | Integer | 日志总数 示例值：100 |
| Status | Integer | 任务状态，0等待下载，1下载中，2下载完成，3下载失败，4文件过期 示例值：0 |
| ExpireTime | String | 文件过期时间 示例值：2023-01-01 00:00:00 |
| Progress | Float | 下载进度 示例值：0.45 |
| ErrorInfo | String | 导出失败信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：检索结果数据为空 |
| UseUserCos | Integer | 是否使用Cos 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
OperatorFilter
查询过滤条件
被如下接口引用：DescribeNDRAssetIdentificationCursorList, DescribeNDRAssetIdentificationList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 过滤字段 示例值：InstanceId |
| Values | Array of String | 是 | 匹配的值 示例值：["ins-17ye5faf"] |
| OperatorType | Integer | 是 | 操作类型： 1：等于 field = value 2：大于 field > value 3：小于 field < value 4：大于等于 field >= value 5：小于等于 field <= value 6：不等于 field <> value 7：IN field IN (value1, value2...) 8：NOT IN field NOT IN (value1, value2...) 9：模糊匹配 field LIKE value 13：非模糊匹配 field NOT LIKE value 14：按位与 field & value = value 15：between and field between value1 and value2 示例值：1 |
PolicyRoutePreCheckReport
策略路由预编排配额报告
被如下接口引用：DescribeClusterNatCcnFwSwitchList, DescribeClusterVpcFwSwitchs。
| 名称 | 类型 | 描述 |
|---|---|---|
| NextHopCount | Integer | 本次编排生成的下一跳数量 示例值：2 |
| NextHopLimit | Integer | 下一跳上限 示例值：5 |
| MatchRuleCount | Integer | 本次编排生成的匹配规则数 示例值：6 |
| MatchRuleLimit | Integer | 匹配规则上限 示例值：100 |
| CloudExistingRuleCount | Integer | 云上已有匹配规则数（其他防火墙类型占用） 示例值：0 |
| CloudExistingNextHopCount | Integer | 云上已有下一跳数（其他防火墙类型占用） 示例值：0 |
| AvailableRuleQuota | Integer | 可用匹配规则配额 = MatchRuleLimit - CloudExistingRuleCount - MatchRuleCount 示例值：94 |
| AvailableNextHopQuota | Integer | 可用下一跳配额 = NextHopLimit - CloudExistingNextHopCount - NextHopCount 示例值：3 |
RegionCidrConfig
引流地域CIDR配置
被如下接口引用：CheckClusterVpcFwPreAccess, ModifyClusterVpcFwSwitch, UpdateClusterVpcFw。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Region | String | 是 | 引流地域 注意：此字段可能返回 null，表示取不到有效值。 示例值：eu-frankfurt |
| CidrMode | Integer | 是 | CIDR模式：0-跳过，1-自动，2-自定义 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| CustomCidr | String | 是 | 自定义CIDR（CidrMode=2时必填），其它时候为空字符串 注意：此字段可能返回 null，表示取不到有效值。 示例值：10.189.0.0/26 |
RegionFwStatus
地域的防火墙引流网络状态
被如下接口引用：DescribeCcnInstanceRegionStatus。
| 名称 | 类型 | 描述 |
|---|---|---|
| Region | String | 地域 示例值：ap-guangzhou |
| Status | String | 引流网络部署状态
示例值：Auto |
| Cidr | String | 引流网络的cidr，如果没有部署引流网络则为空 示例值：172.31.0.0/26 |
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 |
RuleScopeInfo
规则生效范围信息
被如下接口引用：DescribeNatRuleScopes。
| 名称 | 类型 | 描述 |
|---|---|---|
| Scope | String | NAT边界防火墙：ALL，全局生效；ap-guangzhou，生效的地域；cfwnat-xxx，生效基于实例维度 注意：此字段可能返回 null，表示取不到有效值。 示例值：ALL |
| ScopeDesc | String | 生效范围描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：全局规则 |
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 |
SearchLogErrors
多日志主题检索错误信息
被如下接口引用：SearchLog。
| 名称 | 类型 | 描述 |
|---|---|---|
| TopicId | String | 日志主题ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cfw_netflow_border |
| ErrorMsg | String | 错误信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：SyntaxError [field: xxx, can not search on this field, since it is not indexed] |
| ErrorCodeStr | String | 错误码 注意：此字段可能返回 null，表示取不到有效值。 示例值：FailedOperation.QueryError |
SearchLogInfos
多日志主题检索topic信息
被如下接口引用：SearchLog。
| 名称 | 类型 | 描述 |
|---|---|---|
| TopicId | String | 日志主题ID 示例值：cfw_netflow_border |
| Period | Integer | 日志存储生命周期 示例值：30 |
| Context | String | 透传本次接口返回的Context值，可获取后续更多日志，过期时间1小时 注意：此字段可能返回 null，表示取不到有效值。 示例值：Y29udGV4dC04MjMzNWRkMi01YmMxLTQ4NGYtYjQ4MS04MDg0NzAwYjQ1NDUxNjcy |
SearchLogTopics
多主题检索返回信息
被如下接口引用：SearchLog。
| 名称 | 类型 | 描述 |
|---|---|---|
| Errors | Array of SearchLogErrors | 多日志主题检索对应的错误信息 注意：此字段可能返回 null，表示取不到有效值。 |
| Infos | Array of SearchLogInfos | 多日志主题检索各日志主题信息 注意：此字段可能返回 null，表示取不到有效值。 |
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 | 否 | 生成双向下发规则 |
| 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 |
SecurityGroupRegion
安全组地域配置
被如下接口引用：DescribeSecurityGroupRegionList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Region | String | 地域 示例值：ap-shanghai |
| RegionId | String | 地域Id 示例值：54 |
| RegionName | String | 地域中文 示例值：武汉 |
SecurityGroupRule
企业安全组规则内容。新增和修改规则内容共用此结构；字段的校验、缺省、归一化及在两种操作中的处理行为见各字段说明。
被如下接口引用：AddEnterpriseSecurityGroupRules, DescribeEnterpriseSecurityGroupRule, ModifyEnterpriseSecurityGroupRule。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Description | String | 是 | 规则用途或使用场景的描述，不能为空，最多 100 个 Unicode 字符。 示例值：andy创建的规则 |
| DestContent | String | 是 | 访问目的内容，非空且最多 512 字节，格式由 DestType 决定：net 使用 IPv4 IP/CIDR，且不接受裸地址 0.0.0.0，表示全部 IPv4 地址时使用 0.0.0.0/0；template 使用通过 VPC DescribeAddressTemplates 或 DescribeAddressTemplateGroups 查询的广州地域（ap-guangzhou）地址模板 ID，即 AddressTemplateId（ipm-）或 AddressTemplateGroupId（ipmg-）；instance 使用 DescribeCfwAssets 返回的 assets[].instance_id；resourcegroup 使用 DescribeResourceGroupNew（QueryType=resource）返回的 GroupId；tag 根据 DescribeResourceGroupNew（QueryType=tag）返回的 GroupName 构造 {"Key":"标签键","Value":"标签值"}；region 使用 DescribeSecurityGroupRegionList 返回的 Data[].Region；dnsparse 使用合法域名并按小写处理，同时受域名解析配额限制。 示例值：ins-fmo10koi |
| DestType | String | 是 | 访问目的类型，不区分大小写：net 表示 IP/CIDR，template 表示地址模板，instance 表示资产实例，resourcegroup 表示资产分组，tag 表示资源标签，region 表示资产地域，dnsparse 表示 DNS 解析匹配。内容必须与类型匹配，并且对当前账号有效。 示例值：instance |
| OrderIndex | String | 是 | 规则顺序的十进制整数字符串；-1 转换为 uint32 最大值。新增时 Type=0 或 1 会按 Data 数组顺序重新计算最终 Sequence；Type=2 使用首条规则的 OrderIndex 作为插入位置，超过当前最大 Sequence 时按末尾新增处理。修改规则内容时 -1 会被拒绝，超过当前最大 Sequence 的值归一化为当前最大 Sequence。 示例值：-1 |
| RuleAction | String | 是 | 访问控制动作，不区分大小写：accept 表示放行，drop 表示拒绝，log 表示观察；isolateinaccept 表示放行访问隔离资产的白名单流量，isolateindrop 表示阻断访问隔离资产的其它流量，isolateoutaccept 表示放行隔离资产访问白名单目标，isolateoutdrop 表示阻断隔离资产访问其它目标。 示例值：accept |
| SourceContent | String | 是 | 访问源内容，非空且最多 512 字节，格式由 SourceType 决定：net 使用 IPv4 IP/CIDR，且不接受裸地址 0.0.0.0，表示全部 IPv4 地址时使用 0.0.0.0/0；template 使用通过 VPC DescribeAddressTemplates 或 DescribeAddressTemplateGroups 查询的广州地域（ap-guangzhou）地址模板 ID，即 AddressTemplateId（ipm-）或 AddressTemplateGroupId（ipmg-）；instance 使用 DescribeCfwAssets 返回的 assets[].instance_id；resourcegroup 使用 DescribeResourceGroupNew（QueryType=resource）返回的 GroupId；tag 根据 DescribeResourceGroupNew（QueryType=tag）返回的 GroupName 构造 {"Key":"标签键","Value":"标签值"}；region 使用 DescribeSecurityGroupRegionList 返回的 Data[].Region。 示例值：ipm-dyodhpby |
| SourceType | String | 是 | 访问源类型，不区分大小写：net 表示 IP/CIDR，template 表示地址模板，instance 表示资产实例，resourcegroup 表示资产分组，tag 表示资源标签，region 表示资产地域。内容必须与类型匹配，并且对当前账号有效；dnsparse 作为 SourceType 时仅按普通字符串保存，不提供 DNS 解析匹配，请勿使用；DNS 解析匹配仅用于 DestType。 示例值：template |
| Enable | String | 否 | 规则状态字符串，不区分大小写；true 表示启用，false 表示禁用，省略或空字符串在结构转换时按 true 解析。普通新增最终使用账号的新增规则默认状态；batch_import 和 batch_import_cover 新增保留 Data.Enable 的解析结果；修改规则内容时保留原规则状态，因此 Data.Enable 不改变该修改的启停结果。 示例值：true |
| Id | String | 否 | 规则 ID，使用十进制数字字符串。普通新增由系统分配；仅 IsUseId=1 的新增请求采用 Data.Id。修改规则内容时忽略 Data.Id，并保留 RuleUuid 指定的规则 ID。 示例值：47481 |
| Port | String | 否 | 访问控制端口字符串，最多 200 字节。未使用服务模板时必填，可传 1..65535 的单端口、斜杠连接的端口范围、最多 15 个逗号分隔项，或 -1/-1 表示全部端口；Protocol 为 ANY 或 ICMP 时必须为 -1/-1。使用 ServiceTemplateId 时，Protocol 和 Port 可同时省略或留空；如填写非空值则必须为 Protocol=ANY、Port=-1/-1。 示例值：-1/-1 |
| Protocol | String | 否 | IPv4 企业安全组协议，使用区分大小写的大写值 ANY、TCP、UDP 或 ICMP；ANY 表示所有 IPv4 协议。未使用服务模板时必填，ANY 和 ICMP 必须搭配 Port=-1/-1；使用 ServiceTemplateId 时，Protocol 和 Port 可同时省略或留空，如填写非空值则必须为 Protocol=ANY、Port=-1/-1。ICMPv6 使用独立的 IPv6 企业安全组接口。 示例值：ANY |
| Scope | String | 否 | 规则生效范围，使用大写 SG、LH、NONE 或无空格的逗号分隔组合；SG 表示安全组，LH 表示轻量应用服务器，NONE 表示未设置范围。新增时省略默认为 SG；修改规则内容时省略或使用 NONE 均保留原范围。组合项会去重。范围包含 LH 时，SourceType、DestType 均不能为 template，且不能使用 ServiceTemplateId。 示例值：SG |
| ServiceTemplateId | String | 否 | 协议端口模板 ID，最多 50 字节。仅支持通过 VPC DescribeServiceTemplates 或 DescribeServiceTemplateGroups 查询的广州地域（ap-guangzhou）服务模板，即 ServiceTemplateId（ppm-）或 ServiceTemplateGroupId（ppmg-）。非空时 Protocol 和 Port 可同时省略或留空；如填写非空值则必须为 Protocol=ANY、Port=-1/-1。Scope 包含 LH 时不能使用服务模板。 示例值：ppmg-jz17vpis |
| Uid | String | 否 | 保留字段。新增和修改请求均忽略 Uid，无法通过该字段指定或保留规则标识，建议省略。 示例值：1 |
SecurityGroupSimplifyRule
企业安全组规则摘要。
被如下接口引用：AddEnterpriseSecurityGroupRules。
| 名称 | 类型 | 描述 |
|---|---|---|
| Description | String | 规则描述。 示例值：规则描述 |
| 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 | 写入规则的协议。普通 IPv4 规则返回 ANY、TCP、UDP 或 ICMP；使用服务模板时，Protocol 可省略或留空，此时返回空字符串；若仍显式填写 Protocol，则只接受 ANY 并返回 ANY。 示例值：ANY |
| RuleUuid | Integer | 规则 ID。 示例值：8888 |
| Scope | String | 写入后的规则生效范围；SG 表示安全组，LH 表示轻量应用服务器，组合范围以逗号分隔。 示例值：SG |
| Sequence | Integer | 写入后的实际规则顺序。 示例值：1 |
| 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 |
SequenceData
执行顺序对象
被如下接口引用：ModifySequenceRules。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | Integer | 是 | 规则Id值 示例值：9851 |
| OrderIndex | Integer | 是 | 修改前执行顺序 示例值：21 |
| NewOrderIndex | Integer | 是 | 修改后执行顺序 示例值：22 |
SerialRegionInfo
防火墙串行地域带宽分配情况
被如下接口引用：DescribeSerialRegion。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Region | String | 是 | 地域 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-guangzhou |
| Width | Integer | 否 | 分配带宽值 单位Mbps 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| ElasticSwitch | Integer | 否 | 弹性开关 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| ElasticBandwidth | Integer | 否 | 弹性带宽上限，单位Mbps 注意：此字段可能返回 null，表示取不到有效值。 示例值：1024 |
| InFlowMax | Integer | 否 | 七天入向峰值带宽，单位bps 示例值：1000 |
| OutFlowMax | Integer | 否 | 七天出向峰值带宽，单位bps 示例值：1000 |
| ElasticTrafficSwitch | Integer | 否 | 边界按流量弹性开关 取值范围：[0, 1] 默认值：0 示例值：0 |
SgDnsParseCount
企业安全组域名解析的IP统计
被如下接口引用：DescribeEnterpriseSecurityGroupRuleList。
| 名称 | 类型 | 描述 |
|---|---|---|
| ValidCount | Integer | 有效下发的IP个数，离散数据 示例值：10 |
| InvalidCount | Integer | 未下发的IP个数，离散数据 示例值：10 |
StaticInfo
StaticInfo 告警柱形图统计信息
被如下接口引用：DescribeBlockStaticList, DescribeTLogIpList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Address | String | 地址 示例值：上海 |
| InsID | String | 资产id 示例值：ins-nl6svll8 |
| InsName | String | 资产名称 示例值：Dev Proxy |
| Ip | String | ip信息 示例值：“183.45.1.2" |
| Num | Integer | 数 示例值：10 |
| Port | String | 端口 示例值：80 |
StorageHistogram
日志存储统计柱形图
被如下接口引用：DescribeLogStorageStatistic。
| 名称 | 类型 | 描述 |
|---|---|---|
| AclSize | Integer | 访问控制日志存储量，单位B 注意：此字段可能返回 null，表示取不到有效值。 示例值：1024 |
| IdsSize | Integer | 入侵防御日志存储量，单位B 注意：此字段可能返回 null，表示取不到有效值。 示例值：1024 |
| NetFlowSize | Integer | 流量日志存储量，单位B 注意：此字段可能返回 null，表示取不到有效值。 示例值：1024 |
| OperateSize | Integer | 操作日志存储量，单位B 注意：此字段可能返回 null，表示取不到有效值。 示例值：1024 |
| Time | String | 统计时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-06-30 |
| NDRNetflowSize | Integer | NDR流量日志存储量，单位B 示例值：1024 |
| NDRRiskSize | Integer | NDR风险日志存储量，单位B 示例值：1024 |
StorageHistogramShow
前端图表使用日志存储统计柱形图数据
被如下接口引用：DescribeLogStorageStatistic。
| 名称 | 类型 | 描述 |
|---|---|---|
| StorageType | Array of String | 存储类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：["访问控制日志"] |
| Dates | Array of String | 日期 注意：此字段可能返回 null，表示取不到有效值。 示例值：["2024-10-24"] |
| Data | Array of IntArray | 数据 注意：此字段可能返回 null，表示取不到有效值。 示例值：[1024000] |
SwitchError
开关切换错误
被如下接口引用：DescribeSwitchError。
| 名称 | 类型 | 描述 |
|---|---|---|
| ErrIns | String | 开关唯一标识 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.1.1.1 |
| ErrMsg | String | 错误信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：3个防火墙开关开启失败(17.17.17.17, 18.18.18.18, 19.19.19.19)，原因：需要指定引流子网和引流内网IP，请尝试逐个手动开启 |
| ErrKey | String | 错误类型区分 注意：此字段可能返回 null，表示取不到有效值。 示例值：ERR_ENDPOINT_SUBNET |
| InsertTime | String | 错误时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-07-26 22:46:00 |
SwitchFailInfo
开关开启错误码数据
被如下接口引用：DescribeClusterVpcFwSwitchs。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 自增唯一ID 示例值：1 |
| Name | String | 开关名称 示例值：vpc-gz-client2—vpc-gz-server2 |
| Status | Integer | 防火墙开关变动状态，小于0 示例值：-1 |
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-15181 |
| 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-15181 |
| 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} ] |
| 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-151515","vpc-151515"] |
| FwDeploy | FwDeploy | 是 | 部署地域信息 示例值：{"DeployRegion":"ap-guangzhou","Width":1024,"CrossAZone":1,"Zone":"ap-guangzhou-1","ZoneBak":"ap-guangzhou-2","CdcId":""} |
| FwInsId | String | 否 | 防火墙实例ID (编辑场景传) 示例值：cfwew-151515 |
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的列表 |
| JoinInsLst | Array of VpcFwJoinInstanceType | 否 | VPC防火墙接入网络实例类型列表 |
| FwGateway | Array of FwGateway | 否 | 防火墙网关信息 |
| FwGroupId | String | 否 | 防火墙(组)ID 示例值：cfwg-8f4cd56c |
| RuleUsed | Integer | 否 | 已使用规则数 示例值：10 |
| RuleMax | Integer | 否 | 最大规则数 示例值：5000 |
| Width | Integer | 否 | 防火墙实例带宽 示例值：1024 |
| UserVpcWidth | Integer | 否 | 用户VPC墙总带宽 示例值：5000 |
| JoinInsIdLst | Array of String | 否 | 接入的vpc列表 示例值：["vpc-1515151"] |
| 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 |
| ElasticTrafficSwitch | Integer | 否 | 按流量弹性开关 取值范围：[0, 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。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Description | String | 是 | 规则描述，不超过 100 个字符。新增时按请求值保存；修改时完整替换，不继承旧值。 示例值：andy使用的模板 |
| DestContent | String | 是 | 访问目的内容，由 DestType 决定格式和校验。net/ip 接受合法 IP 或 CIDR 的逗号分隔列表，最多 10 项；domain 接受合法域名的逗号分隔列表或单独的 *，最多 10 项，通配域名最多 5 级，段内通配域名还要求引擎支持对应能力；template 接受当前租户的地址模板标识并归一化为模板 UUID，IP 地址模板必须与 IpVersion 一致，域名地址模板按域名目的校验；dnsparse 接受单个非 IP 域名或当前租户的域名模板，可使用符合级数限制的 *. 前缀泛域名，但不接受单独的 * 或段内通配；domainiptwoverify 接受单个非 IP 精确域名或不含任何通配符的当前租户域名模板；instance 和 tag 必须在当前租户存在，其中 instance 必须具有 IpVersion 对应的私网地址；group 接受资源组标识。归一化后的目的内容超过 1023 字节时请求失败。 示例值：198.51.100.10 |
| DestType | String | 是 | 访问目的类型，不区分大小写。net、ip 均表示 IP/CIDR，template 表示地址模板，instance 表示资产实例，group 表示资产分组，tag 表示资源标签，domain 表示 FQDN 匹配，dnsparse 表示宽松匹配：Host/SNI 与域名匹配，或目的 IP 属于该域名当前 DNS 解析结果，满足任一条件即命中；domainiptwoverify 表示严格匹配：上述两个条件必须同时满足。url 虽可被通用类型映射识别，但 VPC 目的内容不支持。地址模板和部分域名模式要求当前 VPC 防火墙引擎支持对应能力；类型及模板实际类型共同决定 DestContent 和 Protocol 的校验。 示例值：net |
| EdgeId | String | 是 | 规则生效的 VPC 边范围，不区分大小写。ALL 表示全部 VPC 边，cfws- 前缀表示指定 VPC 边；其它格式无效。ALL 要求当前环境支持 VPC 全局规则。 示例值：ALL |
| Enable | String | 是 | 规则状态，不区分大小写：true 表示启用，false 表示禁用。省略或为空时使用账号默认状态；没有可用默认值时启用。 示例值：true |
| OrderIndex | Integer | 是 | 规则在相同 IpVersion 下的顺序。-1 表示追加到末尾；正序号表示在对应位置插入并顺延后续规则。0、其它负数及超范围值不应使用。批量新增按 Rules 顺序依次处理。 示例值：1 |
| Port | String | 是 | 访问端口。除 ICMP 和 ICMPV6 外，支持逗号分隔的正整数单端口或“起始/结束”范围，且起始值不大于结束值；-1/-1 表示全部端口。ICMP 和 ICMPV6 忽略该字段；FTP 仅支持单个正整数端口。 示例值：-1/-1 |
| Protocol | String | 是 | 协议名称，不区分大小写并归一化。ANY 表示不限定协议，不表示省略 Protocol。IP、instance、tag、group 及 IP 地址模板目的支持 TCP、UDP、ICMP、ICMPV6、ANY 和 FTP，其中 FTP 只接受单端口；domain 及域名地址模板目的支持 ANY、HTTP、HTTPS、HTTP/HTTPS、TLS/SSL、SMTP、SMTPS、SMTP/SMTPS 和 DNS，不支持 FTP，domain、tls、ssl 归一化为 TLS/SSL；dnsparse 和 domainiptwoverify 仅支持 TCP 或 UDP。template 按查询到的实际模板类型应用上述限制；填写 ParamTemplateId 时，组内每个协议端口项还会应用相同的目的类型限制。 示例值：ANY |
| RuleAction | String | 是 | 流量通过云防火墙时的处理方式，不区分大小写。accept 表示放行，drop 表示拒绝，log 表示观察；isolateinaccept 表示放行访问隔离资产的白名单流量，isolateindrop 表示阻断访问隔离资产的其它流量，isolateoutaccept 表示放行隔离资产访问白名单目标，isolateoutdrop 表示阻断隔离资产访问其它目标；其它值返回参数错误。 示例值：accept |
| SourceContent | String | 是 | 访问源内容，格式由 SourceType 决定：net/ip 使用最多 10 个逗号分隔的 IP 或 CIDR；template 使用当前账号且匹配 IpVersion 的 IP 地址模板 ID，不支持域名模板；instance、tag 必须属于当前账号，instance 须有对应 IpVersion 的私网地址；group 使用资源组 ID。 示例值：192.168.0.2 |
| SourceType | String | 是 | 访问源类型，不区分大小写：net、ip 均表示 IP/CIDR，template 表示地址模板，instance 表示资产实例，tag 表示资源标签，group 表示资产分组。类型及模板实际类型决定 SourceContent 的格式；template 要求当前环境支持地址模板。 示例值：net |
| BetaList | Array of BetaInfoByACL | 否 | 规则关联的 beta 任务详情。请求中的该字段不参与新增或修改规则构造，主要用于查询返回。 |
| CreateTime | String | 否 | 规则创建时间。请求中的该字段不参与新增或修改规则构造，主要用于查询返回。 示例值：2025-07-24 00:00:00 |
| Deleted | Integer | 否 | 规则删除标记，1 表示已删除，0 表示未删除。请求中的该字段不参与新增或修改规则构造，主要用于查询返回。 示例值：0 |
| DestValueType | String | 否 | 目的实际类型提示，例如区分 IP 地址模板和域名地址模板；新增和修改请求中忽略。 示例值：net |
| DetectedTimes | Integer | 否 | 规则命中次数。请求中的该字段不参与新增或修改规则构造，主要用于查询返回。 示例值：0 |
| EdgeName | String | 否 | EdgeId 对应的 VPC 边名称。请求中的该字段不参与新增或修改规则构造，主要用于查询返回和操作记录展示。 示例值：andy的edge |
| FwGroupId | String | 否 | 规则生效的防火墙组或 CCN 范围，不区分大小写。支持 ALL、cfwg- 前缀和 ccn- 前缀；省略、为空或格式无效时按 ALL 处理。 示例值：ALL |
| FwGroupName | String | 否 | 防火墙组或 CCN 名称。请求中的该字段不参与新增或修改规则构造，主要用于查询返回和操作记录展示。 示例值：防火墙名称 |
| InternalUuid | Integer | 否 | 覆盖导入规则标识。仅 batch_import_cover 接受正整数值；其它新增方式和修改请求中忽略。 示例值：8921 |
| Invalid | Integer | 否 | 查询结果中的规则有效性标记，0 表示有效，1 表示无效。请求中的该字段不参与新增或修改规则构造。 示例值：0 |
| IpVersion | Integer | 否 | IP 版本：0 表示 IPv4，1 表示 IPv6；省略或传入其它整数时按 IPv4 处理。instance 和 IP 地址模板须匹配该版本；直接填写的 net IP/CIDR 也应使用相同版本。 示例值：0 |
| ParamTemplateId | String | 否 | 端口协议组 ID。省略或为空时使用 Protocol 和 Port；非空时必须是当前账号可用的端口协议组，组内协议端口须满足目的类型限制。Protocol 和非 ICMP/ICMPV6 的 Port 仍须使用有效格式。 示例值：pp-1q2w3e4r |
| ParamTemplateName | String | 否 | 端口协议组名称。请求中的该字段不参与新增或修改规则构造，主要用于查询返回。 示例值：常用参数模板 |
| RulePartition | Integer | 否 | 规则位置展示值：1 表示最前，2 表示中间，3 表示最后。新增和修改请求中忽略；仅位置为 2 的规则可修改。 示例值：0 |
| SourceName | String | 否 | 访问源名称。请求中的该字段不参与新增或修改规则构造，主要用于查询返回和操作记录展示。 示例值：来源实例 |
| TargetName | String | 否 | 访问目的名称。请求中的该字段不参与新增或修改规则构造，主要用于查询返回和操作记录展示。 示例值：目的Cvm |
| UpdateTime | String | 否 | 规则最近更新时间。请求中的该字段不参与新增或修改规则构造，主要用于查询返回。 示例值：2025-07-24 01:00:00 |
| Uuid | Integer | 否 | 规则 ID。修改时必须提供当前账号已有且可修改的正整数 Uuid，并完整替换该规则。普通新增、insert_rule 和 batch_import 忽略该字段；batch_import_cover 可使用正整数 ID，非正数值由系统分配。 示例值：8888 |
VpcZoneData
vpc区域数据详情
被如下接口引用：CreateChooseVpcs。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Zone | String | 是 | 可用区 示例值：ap-shanghai-5 |
| Region | String | 是 | vpc节点地域 示例值：ap-shanghai |
