1. 接口描述
接口请求域名: fwm.tencentcloudapi.com 。
查询策略体检风险分类统计数据,包含各类风险的规则数量、处置状态、整改率等信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeRiskCategoryStats。 |
| Version | 是 | String | 公共参数,本接口取值:2025-06-11。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Limit | 否 | Integer | 分页大小,默认20 示例值:20 |
| Offset | 否 | Integer | 分页偏移量,默认0 示例值:0 |
| Product | 否 | String | 产品类型 示例值:EnterpriseSG |
| Filters.N | 否 | Array of CommonFilter | 筛选器 |
| By | 否 | String | 排序字段:"RuleCount", "TreatedCount", "IgnoredCount", "UntreatedCount", "DisposalRate" 示例值:UntreatedCount |
| Order | 否 | String | 顺序 示例值:asc |
| MemberId | 否 | String | 成员Id 示例值:mem-1300846651-100011616646 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 风险分类总数 示例值:8 |
| Data | Array of RiskCategoryItem | 风险分类统计列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询策略体检风险分类统计数据
输入示例
POST / HTTP/1.1
Host: fwm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRiskCategoryStats
<公共请求参数>
{
"Product": "enterprise_sg",
"MemberId": "mem-1300846651-100011616646"
}
输出示例
{
"Response": {
"Data": [
{
"CategoryId": "deviate_baseline",
"CategoryName": "安全基线偏离规则",
"Description": "检测到入向全放行规则,范围过大",
"DisposalRate": 0,
"HasRisk": 1,
"IgnoredCount": 0,
"RemediationStatus": "Incomplete",
"RiskLevel": 2,
"RiskLevelName": "高危",
"RuleCount": 1,
"SubcategoryId": "inbound_accept_any",
"SubcategoryName": "入向全放行规则",
"Suggestion": "检测到入向全放行规则,范围过大。建议根据业务实际需求调整规则,缩小覆盖范围以提升规则精准度。",
"TreatedCount": 0,
"UntreatedCount": 1
},
{
"CategoryId": "invalid_rule",
"CategoryName": "无效规则",
"Description": "规则关联的资产实例、地址模板、资源标签等模板已被部分或全部删除",
"DisposalRate": 0,
"HasRisk": 1,
"IgnoredCount": 0,
"RemediationStatus": "Incomplete",
"RiskLevel": 2,
"RiskLevelName": "高危",
"RuleCount": 1,
"SubcategoryId": "loss_of_effect_rules",
"SubcategoryName": "失效规则",
"Suggestion": "检测到规则关联的资产实例、地址模板、或资源标签等模板已被部分删除。建议直接删除该无效规则。",
"TreatedCount": 0,
"UntreatedCount": 1
},
{
"CategoryId": "invalid_rule",
"CategoryName": "无效规则",
"Description": "规则已被优先级更高的规则覆盖",
"DisposalRate": 0,
"HasRisk": 1,
"IgnoredCount": 0,
"RemediationStatus": "Incomplete",
"RiskLevel": 0,
"RiskLevelName": "低危",
"RuleCount": 2,
"SubcategoryId": "overridden_rules",
"SubcategoryName": "被高优覆盖规则",
"Suggestion": "检测到规则已被优先级更高的规则覆盖。建议删除被覆盖的无效规则。",
"TreatedCount": 0,
"UntreatedCount": 2
}
],
"RequestId": "11a97c77-9c0e-468f-b6a2-02b38c121322",
"Total": 2
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |