Account
账号基本信息,主要有 Uin 和 AppId
被如下接口引用:DescribeStrategyAccounts。
| 名称 | 类型 | 描述 |
|---|---|---|
| AppId | String | 租户appid 示例值:12500000 |
| Uin | String | 租户uin 示例值:10000001 |
| RemainQuota | Integer | 剩余可用额度 示例值:1000 |
| Nickname | String | 租户名称 示例值:天空之蓝 |
| DispatchRuleNum | Integer | 下发规则数 示例值:100 |
| OriginRuleNum | Integer | 产品已有规则数 示例值:100 |
| TotalQuota | Integer | 总额度 示例值:10000 |
| MemberId | String | 成员Id 示例值:mem-1300846651-100011616646 |
AccountGroupInfo
账户组信息
被如下接口引用:DescribeOrganMembers。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| GroupId | String | 否 | 账户组ID 示例值:acg-23ras |
| GroupName | String | 否 | 账户组名称 示例值:生产环境组 |
AccountGroupQuotaDetail
账号组配额详情
被如下接口引用:DescribeStrategyAccounts。
| 名称 | 类型 | 描述 |
|---|---|---|
| GroupId | String | 账号组Id 示例值:acg-2fafs |
| GroupName | String | 账号组名称 示例值:生产组 |
| MemberCount | Integer | 账号组成员数 示例值:2 |
| RemainQuota | Integer | 取组内 RemainQuota 最小成员的值 示例值:10 |
| TotalQuota | Integer | 同上成员的 TotalQuota 示例值:2 |
| DispatchRuleNum | Integer | 同上成员的 DispatchRuleNum 示例值:6 |
| OriginRuleNum | Integer | 同上成员的 OriginRuleNum 示例值:1 |
| BottleneckUin | String | 配额最少的成员 Uin 示例值:1342343243 |
| Members | Array of Account | 成员列表 |
AccountProductDetailStats
单个产品的风险统计详情
被如下接口引用:DescribePolicyRiskAccountProductStats。
| 名称 | 类型 | 描述 |
|---|---|---|
| Product | String | 产品类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:enterprise_sg |
| ProductName | String | 产品名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:企业安全组 |
| PolicyCount | Integer | 体检策略数 注意:此字段可能返回 null,表示取不到有效值。 示例值:200 |
| UntreatedRiskCount | Integer | 待整改风险数 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
| TotalRiskCount | Integer | 总风险数 注意:此字段可能返回 null,表示取不到有效值。 示例值:15 |
| TreatedRiskCount | Integer | 已处置数 注意:此字段可能返回 null,表示取不到有效值。 示例值:3 |
| IgnoredRiskCount | Integer | 已忽略数 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
| RectifyRate | String | 整改率,如 50%,无需整改时为 无需整改 注意:此字段可能返回 null,表示取不到有效值。 示例值:0% |
| LastCheckTime | String | 最近一次体检时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-10-22 10:00:00 |
| SubcategoryIds | Array of String | 子类 ID 列表 示例值:["sub_001", "sub_003", "sub_007"] |
| IsOverdue | Boolean | 是否超时未体检 示例值:true |
AccountStatsGroup
按账号分组的风险统计数据
被如下接口引用:DescribePolicyRiskAccountProductStats。
| 名称 | 类型 | 描述 |
|---|---|---|
| Member | MemberInfo | 成员账号信息 注意:此字段可能返回 null,表示取不到有效值。 |
| UntreatedRiskCount | Integer | 该账号下所有产品待整改风险数汇总 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
| ProductStats | Array of AccountProductDetailStats | 该账号下各产品维度的风险统计列表 注意:此字段可能返回 null,表示取不到有效值。 |
| RectifyRate | String | 整改率 示例值:16.0% |
AddressTemplateSpecification
安全组地址模版
被如下接口引用:DescribeRiskAnalysisDetails。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AddressId | String | 否 | IP地址ID,例如:ipm-2uw6ujo6。 示例值:ipm-2uw6ujo6 |
| AddressGroupId | String | 否 | IP地址组ID,例如:ipmg-2uw6ujo6。 示例值:ipm-2uw6ujo6 |
AnalysisSgRuleInfoResp
企业安全组规则列表信息
被如下接口引用:DescribeRiskAnalysisDetails。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 规则id 等同RuleUuid 示例值:1 |
| RuleId | String | 规则Id 示例值:id-xxxx |
| OrderIndex | Integer | 排序 示例值:1 |
| CfwOrderIndex | Integer | 云防排序 示例值:1 |
| 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 |
| Detail | String | 描述 示例值:规则描述 |
| Region | String | 地域 示例值:ap-guangzhou |
| ServiceTemplateId | String | 服务模板id 示例值:tpm-3c140219 |
| SouInstanceName | String | 源资产名称 示例值:tpm-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 | 端口模板名称 示例值:模板名称 |
| DnsParseCount | SgDnsParseCount | 域名解析的IP统计 |
| Scope | String | 规则生效范围 示例值:SG |
| RulePartition | Integer | 分区: 1防火墙管理最前分区 2是云防规则 3防火墙管理最后分区 示例值:1 |
| GroupId | String | 规则组Id 示例值:fwmrg-xxxxxxxxxx |
| GroupName | String | 规则组名称 示例值:下发规则组 |
| GroupRuleId | String | 规则组内规则id 示例值:539a6900-855b-484c-9c99-ac0c37028ddf |
| StrategyId | String | 策略Id 示例值:fwmsid-xxxxxxxxxx |
| IpVersion | String | ip类型 示例值:ipv4 |
| BelongMember | MemberInfo | 成员信息 注意:此字段可能返回 null,表示取不到有效值。 |
CommonFilter
通用筛选条件
被如下接口引用:DescribeEdgeAclRules, DescribeNatAclRules, DescribeOrganMembers, DescribePolicyRiskAccountProductStats, DescribeRiskCategoryStats, DescribeRiskList, DescribeSecurityGroupRules, DescribeStrategies, DescribeStrategyAccounts, DescribeVpcAclRules。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 否 | 筛选字段名。支持:SecurityGroupId、FwGroupId、Ip(IP地址模糊搜索)、InstanceName(实例名称模糊搜索)、VpcId(VPC ID精确搜索) 注意:此字段可能返回 null,表示取不到有效值。 示例值:SecurityGroupId |
| Values | Array of String | 否 | 筛选值列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[] |
| OperatorType | Integer | 否 | 操作类型。1=等于,7=in,9=模糊匹配 注意:此字段可能返回 null,表示取不到有效值。 示例值:7 |
EdgeAclRuleInfo
互联网边界规则
被如下接口引用:CreateEdgeAclRule, CreateEdgeAclRuleGroup, ModifyEdgeAclRule。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| RuleId | String | 否 | 规则ID,修改规则时必填 示例值:rule_001 |
| OrderIndex | Integer | 否 | 规则执行顺序,数字越小优先级越高,创建规则组时必须从1开始严格递增 示例值:1 |
| Direction | Integer | 否 | 规则方向:0-出站,1-入站 示例值:1 |
| SourceContent | String | 否 | 源地址内容,根据 SourceType 不同有不同的格式:ip 时为 IP/CIDR,domain 时为域名,template 时为模板ID,instance 时为实例ID列表(逗号分隔),tag 时为标签键值对(格式:key:value) 示例值:192.168.1.0/24 |
| SourceType | String | 否 | 源地址类型:ip-IP地址,domain-域名,template-参数模板,instance-实例,tag-标签 示例值:ip |
| TargetContent | String | 否 | 目标地址内容,格式同 SourceContent 示例值:10.0.0.0/8 |
| TargetType | String | 否 | 目标地址类型:ip-IP地址,domain-域名,template-参数模板,instance-实例,tag-标签 示例值:ip |
| Port | String | 否 | 端口,支持单端口、端口范围和逗号分隔的多端口,如:80、1-65535、80,443,8080 示例值:80,443 |
| Protocol | String | 否 | 协议类型:TCP、UDP、ICMP、ANY 示例值:TCP |
| RuleAction | String | 否 | 规则动作:accept-放行,drop-阻断,log-观察 示例值:accept |
| Description | String | 否 | 规则描述,长度0-256字符 示例值:允许内网访问 |
| Scope | String | 否 | 生效范围:serial,串行;side,旁路;all,全局 示例值:all |
| BelongMemberId | String | 否 | 规则归属的成员账号ID(多账号场景下使用)。当 SourceType 或 TargetType 为 instance 或 tag 时,此参数必填,用于指定实例/标签所属的成员账号 示例值:100023718505 |
| ParamTemplateId | String | 否 | 参数模板 示例值:pp-23432 |
EdgeAclRuleResp
互联网边界规则响应结构
被如下接口引用:DescribeEdgeAclRules。
| 名称 | 类型 | 描述 |
|---|---|---|
| RuleId | String | 规则ID 示例值:rule_001 |
| Sequence | Integer | 规则执行顺序 示例值:1 |
| Direction | Integer | 规则方向:0-出站,1-入站 示例值:1 |
| SourceContent | String | 源地址内容 示例值:192.168.1.0/24 |
| SourceType | String | 源地址类型 示例值:ip |
| SourceName | String | 源地址名称(当类型为模板/实例/标签时返回对应名称) 注意:此字段可能返回 null,表示取不到有效值。 示例值:内网模板 |
| TargetContent | String | 目标地址内容 示例值:10.0.0.0/8 |
| TargetType | String | 目标地址类型 示例值:ip |
| TargetName | String | 目标地址名称(当类型为模板/实例/标签时返回对应名称) 注意:此字段可能返回 null,表示取不到有效值。 示例值:生产环境服务器 |
| Port | String | 目标端口 示例值:80,443 |
| Protocol | String | 协议类型 示例值:TCP |
| RuleAction | String | 规则动作:accept-放行,drop-阻断,log-观察 示例值:accept |
| Description | String | 规则描述 示例值:允许内网访问 |
| Scope | String | 规则生效范围 示例值:0 |
| CountryName | String | 地域名称1(正则匹配时使用) 注意:此字段可能返回 null,表示取不到有效值。 示例值:中国 |
| CityName | String | 地域名称2(正则匹配时使用) 注意:此字段可能返回 null,表示取不到有效值。 示例值:北京 |
| ParamTemplateId | String | 参数模板ID(当类型为模板时返回) 注意:此字段可能返回 null,表示取不到有效值。 示例值:tpl_001 |
| ParamTemplateName | String | 参数模板名称(当类型为模板时返回) 注意:此字段可能返回 null,表示取不到有效值。 示例值:内网地址模板 |
| Invalid | Integer | 规则是否失效:0-有效,1-失效 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| BelongMember | MemberInfo | 规则归属的成员账号 注意:此字段可能返回 null,表示取不到有效值。 |
| CountryCode | Integer | 国家Id 示例值:0 |
| CityCode | Integer | 城市Id 示例值:0 |
| IsRegion | Integer | 0为正常规则,1为地域规则 示例值:0 |
| CloudCode | String | 云厂商code 示例值:0 |
| IsCloud | Integer | 0为正常规则,1为云厂商规则 示例值:0 |
| InstanceName | String | 实例名称 示例值:内部接口实例 |
| CountryKey | String | 地区简称 示例值:zd |
| CityKey | String | 省份、城市简称 示例值:hn43 |
| CreateTime | String | 规则创建时间 示例值:2025-07-24 12:20:21 |
| UpdateTime | String | 规则最近更新时间 示例值:2025-07-24 12:20:21 |
| DnsParseCnt | Integer | 域名数 示例值:0 |
MemberInfo
成员信息
被如下接口引用:DescribeEdgeAclRules, DescribeNatAclRules, DescribeOrganSummary, DescribePolicyRiskAccountProductStats, DescribeRiskAnalysisDetails, DescribeSecurityGroupRules, DescribeStrategies, DescribeStrategy, DescribeVpcAclRules。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AppId | String | 否 | 成员AppId 示例值:16898822 |
| Uin | String | 否 | 成员Uin 示例值:12121212 |
| Nickname | String | 否 | 成员昵称 示例值:天空之蓝 |
| MemberId | String | 否 | 成员Id 示例值:1212-3232 |
NatAclRule
NAT边界规则
被如下接口引用:CreateNatAclRule, CreateNatAclRuleGroup, ModifyNatAclRule。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SourceContent | String | 是 | 源地址内容 示例值:10.0.0.0/24 |
| SourceType | String | 是 | 源类型:ip/url/template/instance/tag 示例值:ip |
| TargetContent | String | 是 | 目的地址内容 示例值:0.0.0.0/0 |
| TargetType | String | 是 | 目的类型:ip/url/template/instance/tag 示例值:ip |
| Protocol | String | 是 | 协议:TCP/UDP/ICMP/ANY/HTTP/HTTPS/DNS/FTP等 示例值:TCP |
| RuleAction | String | 是 | 动作:accept/drop/log 示例值:accept |
| OrderIndex | Integer | 是 | 优先级(从1开始) 示例值:1 |
| Scope | String | 是 | 规则生效范围:ALL-全局生效,ap-xxx-地域生效,cfwnat-xxx-NAT防火墙实例生效 示例值:ALL |
| Direction | Integer | 否 | 规则方向:1-入站规则,0-出站规则 示例值:1 |
| RuleId | String | 否 | 规则ID(修改时必填) 注意:此字段可能返回 null,表示取不到有效值。 示例值:uuid-xxx |
| Port | String | 否 | 端口(ICMP协议时为空) 注意:此字段可能返回 null,表示取不到有效值。 示例值:80 |
| Description | String | 否 | 规则描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:允许HTTP流量 |
| ParamTemplateId | String | 否 | 端口模板ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:ppm-xxx |
| BelongMemberId | String | 否 | 规则归属的成员账号ID(当Scope为cfwnat-xxx或SourceType/DestType为instance/tag时必填) 注意:此字段可能返回 null,表示取不到有效值。 示例值:1300448058 |
NatAclRuleResp
NAT边界规则响应结构
被如下接口引用:DescribeNatAclRules。
| 名称 | 类型 | 描述 |
|---|---|---|
| RuleId | String | 规则ID 示例值:uuid-xxx |
| Sequence | Integer | 优先级 示例值:1 |
| Direction | Integer | 规则方向:0-出向,1-入向 示例值:1 |
| SourceContent | String | 源地址内容 示例值:10.0.0.0/24 |
| SourceType | String | 源类型 示例值:ip |
| SourceName | String | 源资产名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:ins-xxx |
| TargetContent | String | 目的地址内容 示例值:0.0.0.0/0 |
| TargetType | String | 目的类型 示例值:ip |
| TargetName | String | 目的资产名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:ins-xxx |
| Port | String | 端口 注意:此字段可能返回 null,表示取不到有效值。 示例值:80 |
| Protocol | String | 协议 示例值:TCP |
| RuleAction | String | 动作:accept/drop/log 示例值:accept |
| Description | String | 规则描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:允许HTTP流量 |
| Scope | String | 规则生效范围 示例值:ALL |
| ScopeDesc | String | 规则生效范围描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:全部实例 |
| FwInsId | String | 防火墙实例ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:cfwnat-xxx |
| CountryName | String | 国家名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:中国 |
| CityName | String | 城市名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:北京 |
| CountryCode | Integer | 国家代码 注意:此字段可能返回 null,表示取不到有效值。 示例值:86 |
| CityCode | Integer | 城市代码 注意:此字段可能返回 null,表示取不到有效值。 示例值:131 |
| CountryKey | String | 国家键值 注意:此字段可能返回 null,表示取不到有效值。 示例值:CN |
| CityKey | String | 城市键值 注意:此字段可能返回 null,表示取不到有效值。 示例值:BJ |
| IsRegion | Integer | 是否地域规则:0-否,1-是 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| CloudCode | String | 云厂商代码 注意:此字段可能返回 null,表示取不到有效值。 示例值:tencent |
| IsCloud | Integer | 是否云厂商规则:0-否,1-是 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| ParamTemplateId | String | 端口模板ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:ppm-xxx |
| ParamTemplateName | String | 端口模板名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:端口模板-HTTP |
| Invalid | Integer | 规则是否失效:0-有效,1-失效 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| BelongMember | MemberInfo | 规则归属的成员账号 注意:此字段可能返回 null,表示取不到有效值。 |
| CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-01-01 12:00:00 |
| UpdateTime | String | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-01-01 12:00:00 |
| DnsParseCnt | Integer | 域名数 示例值:0 |
OrganMemberItem
集团成员信息
被如下接口引用:DescribeOrganMembers。
| 名称 | 类型 | 描述 |
|---|---|---|
| MemberId | String | 成员 ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:mem-1300448058-100027980407 |
| AppId | String | 成员账号 AppId 注意:此字段可能返回 null,表示取不到有效值。 示例值:1302385041 |
| Uin | String | 账号Uin 示例值:100027980407 |
| Nickname | String | 账号名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:子公司A |
| SubAccountCount | Integer | 子账号数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:5 |
| NodeName | String | 所属组织架构节点名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:技术部 |
| Role | String | 成员身份:admin-管理员,delegatedAdmin-委派管理员,member-普通成员 注意:此字段可能返回 null,表示取不到有效值。 示例值:member |
| RoleDisplay | String | 成员身份显示名称(前端展示用) 注意:此字段可能返回 null,表示取不到有效值。 示例值:普通成员 |
| AccountGroup | AccountGroupInfo | 所属账户组 注意:此字段可能返回 null,表示取不到有效值。 |
| CfwManaged | Integer | 云防火墙纳管状态:0-未纳管,1-已纳管 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| CfwShareRole | String | 云防火墙共享角色:sharer-共享者,user-使用者,none-未设置 注意:此字段可能返回 null,表示取不到有效值。 示例值:sharer |
| CfwShareRoleDisplay | String | 云防火墙共享角色显示名称(前端展示用) 注意:此字段可能返回 null,表示取不到有效值。 示例值:共享者 |
| CfwSharerAppId | String | 云防火墙共享者 AppId,成员角色为使用者时有值 注意:此字段可能返回 null,表示取不到有效值。 示例值:1300448058 |
| CfwInstanceId | String | 云防火墙计费实例 ID,非空表示已购买云防火墙 注意:此字段可能返回 null,表示取不到有效值。 示例值:cfwins-abc12345 |
| PolicyAnalysisEnabled | Integer | 策略分析权限:0-关闭,1-开启 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| MemberCreateTime | String | 成员加入集团时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-01-15 10:30:00 |
| JoinType | String | 账号加入方式 示例值:invite |
OrganSummary
集团概览
被如下接口引用:DescribeOrganSummary。
| 名称 | 类型 | 描述 |
|---|---|---|
| GroupName | String | 集团名称 示例值:腾讯云集团 |
| AdminInfo | MemberInfo | 管理员账号信息 |
| AdminCount | Integer | 管理员/委派管理员数量 示例值:2 |
| JoinedMemberCount | Integer | 已接入成员数 示例值:10 |
| MemberLimit | Integer | 接入成员上限(-1表示无上限) 示例值:100 |
| MemberLimitDisplay | String | 接入成员上限显示 示例值:100 |
| CfwSharerCount | Integer | 规格共享者数量 示例值:3 |
| CfwUserCount | Integer | 规格使用者数量 示例值:5 |
| Departments | Array of String | 部门名称列表 示例值:["root"] |
| ManagedMemberCount | Integer | 纳管账号数 示例值:1 |
| ManagedProductCount | Integer | 纳管产品数 示例值:1 |
| CfwManageCount | Integer | 纳管账号数 示例值:2 |
PolicyRisk
策略风险
被如下接口引用:DescribeRiskList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | String | 是 | 问题对应的唯一uuid 示例值:s1w45 |
| RiskCategory | String | 否 | 风险大类 示例值:无效规则 |
| RiskSubCategory | String | 否 | 风险子类 示例值:未命中规则 |
| RuleType | String | 否 | 规则分类 示例值:拒绝规则 |
| RiskLevel | Integer | 否 | 风险等级,0:低风险 1:中风险 2:高风险 示例值:2 |
| Product | String | 否 | 安全组 示例值:所属产品 |
| SgRuleId | Array of String | 否 | 风险包含的企业安全组规则ID 示例值:["fwm-04556"] |
| RuleCount | Integer | 否 | 风险包含安全组ID内的问题规则数 示例值:2 |
| SgId | Array of String | 否 | 风险包含的安全组ID 示例值:["sg-888"] |
| RiskFeature | String | 否 | 风险特征 示例值:无效规则 |
| Suggestion | String | 否 | 处置建议 示例值:基于业务实际需求,可考虑删除规则 |
| Status | Integer | 否 | 处置状态,0:未处理,1:已处理,2:忽略 示例值:0 |
| FoundTime | String | 否 | 发现时间 示例值:2025-06-30 12:00:00 |
| DisposalTime | String | 否 | 处置时间 示例值:2025-06-30 13:00:00 |
| Region | String | 否 | 安全组地域 示例值:ap-guangzhou |
| Direction | String | 否 | Ingress入站,Egress出站 示例值:Egress |
| RiskReason | String | 否 | 风险原因 示例值:源IP、目的IP都是1.1.1.1,2.2.2.2 |
ReceiveAccount
账号信息
被如下接口引用:DescribeStrategies, DescribeStrategy。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Uin | String | 否 | 租户 uin 示例值:100000001 |
| Nickname | String | 否 | 租户名称 示例值:腾讯云 |
| ReceiverType | Integer | 否 | 0=账号uin,1=账号组 示例值:1 |
| Members | Array of MemberInfo | 否 | 只有ReceiverType 是 1 时 才返回账号列表 |
RiskCategoryItem
风险分类统计项
被如下接口引用:DescribeRiskCategoryStats。
| 名称 | 类型 | 描述 |
|---|---|---|
| CategoryId | String | 风险大类ID 示例值:invalid_rule |
| CategoryName | String | 风险大类名称 示例值:无效规则 |
| SubcategoryId | String | 风险子类ID 示例值:loss_of_effect_rules |
| SubcategoryName | String | 风险子类名称 示例值:失效规则 |
| RiskLevel | Integer | 风险等级(0-低危,1-中危,2-高危) 示例值:2 |
| RiskLevelName | String | 风险等级名称(低/中/高) 示例值:高 |
| Description | String | 风险描述 示例值:规则关联的资产实例、地址模板、资源标签等模板已被部分或全部删除 |
| Suggestion | String | 处置建议 示例值:建议直接删除该无效规则 |
| RuleCount | Integer | 该类风险的规则数量 示例值:15 |
| TreatedCount | Integer | 已处置数量 示例值:8 |
| IgnoredCount | Integer | 已忽略数量 示例值:2 |
| UntreatedCount | Integer | 待整改数量 示例值:5 |
| DisposalRate | Integer | 整改率(百分比字符串) 示例值:66 |
| HasRisk | Integer | 是否有未处理风险 -1: 未体检 0: 无风险 1: 有风险 示例值:0 |
| RemediationStatus | String | 整改状态: Completed: 已整改完成(整改率 100%) Incomplete: 未整改完成(整改率 < 100%) -:未体检/无数据 示例值:Completed |
SecGroupRuleResp
企业安全组规则列表信息
被如下接口引用:DescribeSecurityGroupRules。
| 名称 | 类型 | 描述 |
|---|---|---|
| OrderIndex | Integer | 排序 示例值:1 |
| RuleId | String | 主键id 示例值:uuid |
| IpVersion | String | ip类型 示例值:ipv4 |
| 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 | 端口 示例值:80 |
| Strategy | Integer | 策略 示例值:1 |
| Detail | String | 描述 示例值:放通TCP 80 |
| Region | String | 地域 示例值:ap-guangzhou |
| 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 | 源资产网段信息 示例值:1.1.1.1/10 |
| SouParameterName | String | 源模板名称 示例值:模板名称 |
| InstanceName | String | 目的资产名称 示例值:ins-3c140219 |
| PublicIp | String | 目的资产公网ip 示例值:1.1.1.1 |
| PrivateIp | String | 目的资产内网ip 示例值:1.1.1.1 |
| Cidr | String | 目的资产网段信息 示例值:1.1.1.1/10 |
| ParameterName | String | 目的模板名称 示例值:模板名称 |
| ProtocolPortName | String | 端口模板名称 示例值:模板名称 |
| Id | Integer | 规则id 等同RuleUuid 示例值:1 |
| DnsParseCount | SgDnsParseCount | 域名解析的IP统计 |
| Scope | String | 规则生效范围 示例值:SG |
| IsNew | Integer | 规则最新一次是否有改动 取值范围:0/1 0:否 1:是 示例值:1 |
| BelongMember | MemberInfo | 规则归属的成员账号(当FwGroupId为cfwg-xxx或SourceType/DestType为instance/tag时必填) 注意:此字段可能返回 null,表示取不到有效值。 |
SecurityGroupRiskPolicy
安全组风险规则详情
被如下接口引用:DescribeRiskAnalysisDetails。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PolicyIndex | Integer | 否 | 安全组规则索引号 示例值:0 |
| Protocol | String | 否 | 协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。 示例值:TCP |
| Port | String | 否 | 端口(all, 离散port, range)。 示例值:22 |
| ServiceTemplate | ServiceTemplateSpecification | 否 | 端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。 |
| CidrBlock | String | 否 | 网段或IP(互斥)。 示例值:182.2.2.1 |
| Ipv6CidrBlock | String | 否 | 网段或IPv6(互斥)。 示例值:182.2.2.1 |
| SecurityGroupId | String | 否 | 安全组实例ID,例如:sg-ohuuioma。 示例值:sg-ohuuioma |
| AddressTemplate | AddressTemplateSpecification | 否 | IP地址ID或者ID地址组ID。 |
| Action | String | 否 | 动作:ACCEPT 或 DROP。 示例值:ACCEPT |
| PolicyDescription | String | 否 | 安全组规则描述。 示例值:TEST |
| Version | String | 否 | 安全组规则当前版本 示例值:10 |
| Direction | String | 否 | 规则方向,Egress出站规则,Ingress入站规则 示例值:Egress |
| ModifyTime | String | 否 | 安全组最近修改时间。 示例值:2025-07-01 00:00:00 |
| Region | String | 否 | 安全组所在地域 示例值:ap-guangzhou |
SecurityGroupRule
规则数据结构描述
被如下接口引用:CreateSecurityGroupRule, CreateSecurityGroupRuleGroup, ModifySecurityGroupRule。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| IpVersion | String | 否 | ip类型 示例值:ipv4 |
| SourceContent | String | 否 | 源地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:"0.0.0.0/0" |
| SourceType | String | 否 | 源类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:"net" |
| DestContent | String | 否 | 目的地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:"0.0.0.0/0" |
| DestType | String | 否 | 目的类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:"net" |
| Protocol | String | 否 | 协议 注意:此字段可能返回 null,表示取不到有效值。 示例值:ALL |
| Port | String | 否 | 端口 注意:此字段可能返回 null,表示取不到有效值。 示例值:-1/-1 |
| ServiceTemplateId | String | 否 | 模板 注意:此字段可能返回 null,表示取不到有效值。 示例值:"ippm-12dsa" |
| RuleAction | String | 否 | 动作 注意:此字段可能返回 null,表示取不到有效值。 示例值:"DROP" |
| Description | String | 否 | 描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:"connect" |
| OrderIndex | Integer | 否 | 优先级 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| RuleId | String | 否 | rule id 注意:此字段可能返回 null,表示取不到有效值。 示例值:12222 |
| Scope | String | 否 | 生效范围 注意:此字段可能返回 null,表示取不到有效值。 示例值:"SG" |
| ProtocolPortType | Integer | 否 | 端口类型 示例值:0 |
| BelongMemberId | String | 否 | 规则归属的成员账号ID(当FwGroupId为cfwg-xxx或SourceType/DestType为instance/tag时必填) 示例值:1300448058 |
SequenceIndex
规则序号调整结构
被如下接口引用:ModifyEdgeAclRuleSequence, ModifyNatAclRuleSequence, ModifyStrategySequence, ModifyVpcAclRuleSequence。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| OrderIndex | Integer | 否 | 原规则序号 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| NewOrderIndex | Integer | 否 | 新规则序号 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
ServiceTemplateSpecification
安全组服务模版
被如下接口引用:DescribeRiskAnalysisDetails。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ServiceId | String | 否 | 协议端口ID,例如:ppm-f5n1f8da。 示例值:ppm-f5n1f8da |
| ServiceGroupId | String | 否 | 协议端口组ID,例如:ppmg-f5n1f8da 示例值:ppmg-f5n1f8da |
SgDnsParseCount
企业安全组域名解析的IP统计
被如下接口引用:DescribeRiskAnalysisDetails, DescribeSecurityGroupRules。
| 名称 | 类型 | 描述 |
|---|---|---|
| ValidCount | Integer | 有效下发的IP个数,离散数据 示例值:10 |
| InvalidCount | Integer | 未下发的IP个数,离散数据 示例值:10 |
SgRuleResp
规则列表响应数据结构
被如下接口引用:DescribeSecurityGroupRule。
| 名称 | 类型 | 描述 |
|---|---|---|
| RuleId | String | 规则Id 示例值:fwm_newsg_1300448058_443a085a07b6b578326217e765ecc579_17610187015422 |
| Sequence | Integer | 优先级 示例值:2 |
| Region | String | 区域 示例值:ap-guangzhou |
| IpVersion | String | ip类型 示例值:ipv6 |
| SrcContent | String | 源内容 示例值:2001:db8::/32 |
| SrcType | String | 源类型 示例值:0 |
| DstContent | String | 目的内容 示例值:2001:db8::/32 |
| DstType | String | 目的类型 示例值:0 |
| Protocol | String | 协议 示例值:TCP |
| ProtocolPortType | Integer | 协议端口参数模板 示例值:0 |
| ServiceTemplateId | String | 协议端口参数模板id 示例值:ippm-13nsa |
| DstPort | String | 端口段,支持单端口,多端口和端口段 示例值:3306 |
| RuleAction | String | 策略,1阻断,2放行 示例值:ACCEPT |
| Detail | String | 描述 示例值:Test IPv6 rule |
| RuleSource | String | 规则来源,0为用户控制台添加 示例值:0 |
| Scope | String | 生效范围,字节位,1:SG 企业安全组,2:LH 轻量服务器 示例值:SG |
StrategyReq
创建策略的策略数据结构
被如下接口引用:CreateStrategy。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| GroupId | String | 否 | 规则组Id 示例值:"GR-1234" |
| Sequence | Integer | 否 | 优先级 示例值:1 |
StrategyResp
查询策略时策略列表参数
被如下接口引用:DescribeStrategies, DescribeStrategy。
| 名称 | 类型 | 描述 |
|---|---|---|
| StrategyId | String | 策略Id 示例值:SID-2JSS |
| GroupId | String | 规则组Id 示例值:RG-10KJk |
| GroupName | String | 规则组名称 示例值:重保规则组1 |
| RuleCount | Integer | 规则数 示例值:2 |
| RuleStatus | Integer | 策略状态 示例值:1 |
| ReceiveAccount | Array of ReceiveAccount | 下发账号 |
| Sequence | Integer | 优先级 示例值:1 |
| ErrMsg | String | 下发失败原因 示例值:配额不足 |
| ErrorType | String | 下发失败原因类型 示例值:SG_QUOTA_LIMIT |
| UpdateTime | String | 更新时间 示例值:2025-10-14 11:23:32 |
| CreateBy | String | 创建人 示例值:cfw-test@123 |
| UpdateBy | String | 更新人 示例值:cfw-test@123 |
| ExecArea | String | 执行区域 示例值:post |
| CreateName | String | 创建人名称 示例值:天空之蓝 |
| UpdateName | String | 更新人名称 示例值:天空之蓝 |
| CreateTime | String | 创建时间 示例值:2025-10-14 11:23:32 |
VpcAclRule
VPC边界规则
被如下接口引用:CreateVpcAclRule, CreateVpcAclRuleGroup, ModifyVpcAclRule。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SourceContent | String | 是 | 源地址内容 示例值:10.0.0.0/24 |
| SourceType | String | 是 | 源类型:ip/url/template/instance/tag 示例值:ip |
| DestContent | String | 是 | 目的地址内容 示例值:0.0.0.0/0 |
| DestType | String | 是 | 目的类型:ip/url/template/instance/tag 示例值:ip |
| Protocol | String | 是 | 协议:TCP/UDP/ICMP/ANY/HTTP/HTTPS/DNS/FTP等 示例值:TCP |
| RuleAction | String | 是 | 动作:accept/drop/log 示例值:accept |
| OrderIndex | Integer | 是 | 优先级(从1开始) 示例值:1 |
| EdgeId | String | 是 | 边界防火墙ID:ALL表示全局,CFWS-xxx表示指定边界 示例值:ALL |
| FwGroupId | String | 是 | 防火墙实例ID(规则生效范围):ALL-全局生效,ccn-xxx-云联网实例,cfwg-xxx-防火墙组实例 示例值:ALL |
| RuleId | String | 否 | 规则ID(修改时必填) 示例值:uuid-xxx |
| Port | String | 否 | 端口(ICMP协议时为空) 示例值:80 |
| Description | String | 否 | 规则描述 示例值:允许HTTP流量 |
| ParamTemplateId | String | 否 | 端口模板ID 示例值:ppm-xxx |
| BelongMemberId | String | 否 | 规则归属的成员账号ID(当FwGroupId为cfwg-xxx或SourceType/DestType为instance/tag时必填) 示例值:1300448058 |
VpcAclRuleResp
VPC边界规则响应结构
被如下接口引用:DescribeVpcAclRules。
| 名称 | 类型 | 描述 |
|---|---|---|
| RuleId | String | 规则ID 示例值:uuid-xxx |
| Sequence | Integer | 优先级 示例值:1 |
| IpVersion | String | IP版本:ipv4或ipv6 示例值:ipv4 |
| SourceContent | String | 源地址内容 示例值:10.0.0.0/24 |
| SourceType | String | 源类型 示例值:ip |
| SourceName | String | 源资产名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:ins-xxx |
| DestContent | String | 目的地址内容 示例值:0.0.0.0/0 |
| DestType | String | 目的类型 示例值:ip |
| DestName | String | 目的资产名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:ins-xxx |
| Protocol | String | 协议 示例值:TCP |
| Port | String | 端口 注意:此字段可能返回 null,表示取不到有效值。 示例值:80 |
| ParamTemplateId | String | 端口模板ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:ppm-xxx |
| ParamTemplateName | String | 端口模板名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:端口模板-HTTP |
| RuleAction | String | 动作:accept/drop/log 示例值:accept |
| Description | String | 规则描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:允许HTTP流量 |
| EdgeId | String | 边界防火墙ID 示例值:ALL |
| FwGroupId | String | 防火墙实例ID 示例值:ALL |
| Invalid | Integer | 规则是否失效:0-有效,1-失效 示例值:0 |
| BelongMember | MemberInfo | 规则归属的成员账号 注意:此字段可能返回 null,表示取不到有效值。 |
| CreateTime | String | 规则创建时间 示例值:2026-03-04 16:45:45 |
| UpdateTime | String | 规则修改时间 示例值:2026-03-04 16:45:45 |
| DnsParseCnt | Integer | 域名数 示例值:0 |
| FwGroupName | String | 防火墙组名称 示例值:ccn-klt3mzot |