云防火墙查询防火墙规则优化建议

1. 接口描述

接口请求域名： cfw.tencentcloudapi.com 。

查询当前租户防火墙规则优化建议。只读分析，不修改规则；Action 名保持单数 RuleOptimization。结果在 Response.Data 的 JSON 字符串中。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCfwRuleOptimization。
Version	是	String	公共参数，本接口取值：2019-09-04。
Region	否	String	公共参数，本接口不需要传递此参数。
RuleType	是	String	防火墙规则类型。必填。枚举：border 互联网边界；nat NAT 边界；vpc VPC 间；enterprise_sg 企业安全组。示例值：border
Dimensions.N	否	Array of String	要执行的优化维度白名单。可选，例如 D1、D2、D8；不传默认执行全部支持维度。示例值：["D1"]
IdleDays	否	Integer	长期零命中规则阈值天数。可选，默认 180。示例值：180
IpAggMin	否	Integer	单 IP 离散过多聚合建议的最小数量。可选，默认 10。示例值：10
IocSample	否	Integer	可迁移 IOC 建议中返回的样例 IOC 数量上限。可选，默认 50。示例值：50

3. 输出参数

参数名称	类型	描述
Data	String	查询结果。UTF-8 JSON object 字符串；调用方需解析 Response.Data。示例值：{"appid":"1300448058","finding_total":6,"summary":{"D1":2,"D2":2,"D4":1,"D6":1},"actions":{"disable":[6,7,8],"delete":[13]},"high_risk":[6,7],"rule_active":27,"rule_skipped_geo_or_cloud":3}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询互联网边界规则优化建议

只读返回优化建议；示例仅展示代表性字段，是否处理以及如何处理由调用方决定。

输入示例

POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCfwRuleOptimization
<公共请求参数>

{
    "RuleType": "border",
    "Dimensions": [
        "D1"
    ],
    "IdleDays": 180
}

输出示例

{
    "Response": {
        "Data": "{\"rule_type\":\"border\",\"dimension_counts\":{\"D1\":1},\"finding_total\":1,\"findings\":[{\"dim\":\"D1 完全重复\"}]}",
        "RequestId": "4266525E-10C4-41E1-8A28-5CCE1FBF6A58"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。

查询防火墙规则优化建议

本页目录：