云防火墙查询防火墙规则

1. 接口描述

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

查询当前租户防火墙规则配置。覆盖互联网边界、NAT、VPC、企业安全组，以及入侵防御 intrusion_prevention 的 blocklist、whitelist、isolate 三类有效列表。结果在 Response.Data 的 JSON 字符串中。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCfwRules。
Version	是	String	公共参数，本接口取值：2019-09-04。
Region	否	String	公共参数，本接口不需要传递此参数。
RuleType	是	String	规则域。必填。枚举：border 互联网边界；nat NAT 边界；vpc VPC 间；enterprise_sg 企业安全组；intrusion_prevention 入侵防御。RuleType=intrusion_prevention 时还必须传 ListType。示例值：intrusion_prevention
ListType	否	String	入侵防御列表类型。仅 RuleType=intrusion_prevention 时使用并必填。blocklist 表示封禁列表，whitelist 表示白名单策略，isolate 表示隔离列表。示例值：blocklist
Direction	否	Integer	访问方向过滤。可选。0 表示出站，1 表示入站；不传则不过滤。RuleType=intrusion_prevention 时不支持。示例值：1
RuleAction	否	Integer	规则动作过滤。可选。0 表示观察，1 表示阻断，2 表示放行；不传则不过滤。示例值：1
Enabled	否	Boolean	启用状态过滤。可选。默认只返回启用规则；传 false 只查询禁用规则。示例值：true
IncludeDisabled	否	Boolean	是否同时包含启用和禁用规则。可选。true 表示包含两类；不能和 Enabled 同时使用。示例值：true
RuleId	否	Integer	精确规则 ID 过滤。可选。用于按数值规则标识定位单条规则。示例值：123456
RuleUuid	否	String	精确公开规则标识过滤。可选。推荐在用户提供规则标识时使用。示例值：2108491
Protocol	否	String	协议过滤。可选。例如 TCP、UDP、ICMP、HTTP、HTTPS、ANY；不传则不过滤。示例值：ANY
SrcIp	否	String	源地址或源内容关键字过滤。可选，支持模糊匹配。示例值：0.0.0.0/0
DstIp	否	String	目的地址、目的域名或目的内容关键字过滤。可选，支持模糊匹配。示例值：mb_1300448058_1702352890143
Description	否	String	规则描述关键字过滤。可选。示例值：1
Keyword	否	String	入侵防御列表关键字搜索。可选，最大 100 字符。blocklist 搜索 ioc/address/comment/rule_source；whitelist 搜索 rule_name/ioc/comment/src_ip/dst_ip；isolate 搜索实例、公网 IP、内网 IP、VPC、地域。示例值：办公出口
InstanceId	否	String	精确实例 ID 过滤。仅 RuleType=intrusion_prevention 且 ListType=isolate 时使用；写操作前后核验应使用该参数而不是 Keyword。示例值：ins-lyqnistm
ExpandNames	否	Boolean	是否展开模板、资产组、实例等名称。可选，默认 true；传 false 返回原始标识。示例值：true
Limit	否	Integer	单页返回规则数。可选，默认 100，最大 1000。示例值：100
Offset	否	Integer	分页偏移。可选，默认 0。示例值：0

3. 输出参数

参数名称	类型	描述
Data	String	查询结果。UTF-8 JSON object 字符串；调用方需解析 Response.Data。示例值：{"limit":100,"list_type":"blocklist","list_type_name":"入侵防御封禁列表","offset":0,"returned":0,"rule_type":"intrusion_prevention","rule_type_name":"入侵防御","rules":null,"total":0}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询 NAT 边界规则

查询 NAT 边界 ACL；ExpandNames=false 返回原始规则字段，scope 是修改规则时需要保留的生效范围。

输入示例

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

{
    "RuleType": "nat",
    "ExpandNames": false,
    "Limit": 100
}

输出示例

{
    "Response": {
        "Data": "{\"rule_type\":\"nat\",\"total\":1,\"returned\":1,\"rules\":[{\"sequence\":1,\"src_ip\":\"10.0.0.0/24\",\"dst_content\":\"0.0.0.0/0\",\"protocol\":\"TCP\",\"dst_port\":\"443\",\"scope\":\"ap-guangzhou\"}]}",
        "RequestId": "4266525E-10C4-41E1-8A28-5CCE1FBF6A58"
    }
}

示例2 查询 VPC 间规则

查询 VPC 间 ACL；ip_version 即使为 0 也会保留，修改规则时不得猜测或丢弃。

输入示例

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

{
    "RuleType": "vpc",
    "ExpandNames": false,
    "Limit": 100
}

输出示例

{
    "Response": {
        "Data": "{\"rule_type\":\"vpc\",\"total\":1,\"returned\":1,\"rules\":[{\"sequence\":1,\"protocol\":\"TCP\",\"dst_port\":\"443\",\"ip_version\":0,\"enabled\":true}]}",
        "RequestId": "4266525E-10C4-41E1-8A28-5CCE1FBF6A58"
    }
}

示例3 查询互联网边界规则

查询互联网边界 ACL；Direction=0 表示出站，规则数组包含源、目的、协议、端口、动作和启用状态。

输入示例

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

{
    "RuleType": "border",
    "Direction": 0,
    "ExpandNames": false,
    "Limit": 100,
    "Offset": 0
}

输出示例

{
    "Response": {
        "Data": "{\"rule_type\":\"border\",\"total\":1,\"returned\":1,\"rules\":[{\"sequence\":1,\"src_ip\":\"10.0.0.1\",\"dst_content\":\"0.0.0.0/0\",\"protocol\":\"TCP\",\"dst_port\":\"443\",\"direction\":0,\"action\":1,\"enabled\":true}]}",
        "RequestId": "4266525E-10C4-41E1-8A28-5CCE1FBF6A58"
    }
}

示例4 查询企业安全组规则

查询企业安全组规则；可使用 Protocol、SrcIp、DstIp 和 Description 继续过滤。

输入示例

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

{
    "RuleType": "enterprise_sg",
    "Protocol": "TCP",
    "ExpandNames": false,
    "Limit": 100
}

输出示例

{
    "Response": {
        "Data": "{\"rule_type\":\"enterprise_sg\",\"total\":1,\"returned\":1,\"rules\":[{\"sequence\":1,\"protocol\":\"TCP\",\"dst_port\":\"443\",\"action\":1,\"enabled\":true}]}",
        "RequestId": "4266525E-10C4-41E1-8A28-5CCE1FBF6A58"
    }
}

示例5 查询入侵防御封禁列表

RuleType=intrusion_prevention 时通过 ListType 选择 blocklist、whitelist 或 isolate。

输入示例

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

{
    "RuleType": "intrusion_prevention",
    "ListType": "blocklist",
    "Keyword": "1.1.1.1",
    "Limit": 100
}

输出示例

{
    "Response": {
        "Data": "{\"rule_type\":\"intrusion_prevention\",\"list_type\":\"blocklist\",\"total\":1}",
        "RequestId": "4266525E-10C4-41E1-8A28-5CCE1FBF6A58"
    }
}

示例6 查询入侵防御白名单策略

查询入侵防御白名单策略，ListType 使用 whitelist。

输入示例

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

{
    "RuleType": "intrusion_prevention",
    "ListType": "whitelist",
    "Keyword": "safe.example.com",
    "Limit": 100
}

输出示例

{
    "Response": {
        "Data": "{\"rule_type\":\"intrusion_prevention\",\"list_type\":\"whitelist\",\"total\":1}",
        "RequestId": "4266525E-10C4-41E1-8A28-5CCE1FBF6A58"
    }
}

示例7 查询入侵防御隔离列表

按实例 ID 精确查询入侵防御隔离记录，用于写操作前后核验。

输入示例

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

{
    "RuleType": "intrusion_prevention",
    "ListType": "isolate",
    "InstanceId": "ins-xxxxxxxx"
}

输出示例

{
    "Response": {
        "Data": "{\"rule_type\":\"intrusion_prevention\",\"list_type\":\"isolate\",\"total\":1}",
        "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	参数错误。

查询防火墙规则

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 查询 NAT 边界规则

输入示例

输出示例

示例2 查询 VPC 间规则

输入示例

输出示例

示例3 查询互联网边界规则

输入示例

输出示例

示例4 查询企业安全组规则

输入示例

输出示例

示例5 查询入侵防御封禁列表

输入示例

输出示例

示例6 查询入侵防御白名单策略

输入示例

输出示例

示例7 查询入侵防御隔离列表

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码