轻量应用服务器查询防火墙模板规则列表-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口 (DescribeFirewallTemplateRules) 用于查询防火墙模板规则列表。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeFirewallTemplateRules。
Version	是	String	公共参数，本接口取值：2020-03-24。
Region	否	String	公共参数，本接口不需要传递此参数。
TemplateId	是	String	防火墙模板ID。示例值：lhft-ow2dn19x
TemplateRuleIds.N	否	Array of String	防火墙模板规则ID列表。示例值：["lhftr-gexf7cmvpq"]
Offset	否	Integer	偏移量，默认为 0。示例值：0
Limit	否	Integer	返回数量，默认为 20，最大值为 100。示例值：10

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	防火墙模板规则总数量。示例值：10
TemplateRuleSet	Array of FirewallTemplateRuleInfo	防火墙模板规则信息列表。示例值：[{"FirewallRuleInfo": {"Action": "ACCEPT","AppType": "user-defined","CidrBlock": "0.0.0.0/0","FirewallRuleDescription": "tcp 80","Port": "81","Protocol": "TCP"},"TemplateRuleId": "lhftr-gexf7cmvpq"}]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询防火墙模板规则列表

查询防火墙模板规则列表

输入示例

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

{
    "TemplateId": "lhft-6brh0ciy"
}

输出示例

{
    "Response": {
        "RequestId": "8e3d057f-a651-4c66-b5e3-abb11e305f19",
        "TemplateRuleSet": [
            {
                "FirewallRuleInfo": {
                    "Action": "ACCEPT",
                    "AppType": "user-defined",
                    "CidrBlock": "0.0.0.0/0",
                    "FirewallRuleDescription": "tcp 80",
                    "Port": "81",
                    "Protocol": "TCP"
                },
                "TemplateRuleId": "lhftr-gexf7cmvpq"
            },
            {
                "FirewallRuleInfo": {
                    "Action": "DROP",
                    "AppType": "user-defined",
                    "CidrBlock": "0.0.0.0/0",
                    "FirewallRuleDescription": "udp 80",
                    "Port": "81",
                    "Protocol": "UDP"
                },
                "TemplateRuleId": "lhftr-9uxz9zuz62"
            }
        ],
        "TotalCount": 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: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
InvalidParameterValue.Length	参数取值长度不合法。
ResourceNotFound.FirewallTemplateNotFound	防火墙模板不存在
UnauthorizedOperation.NoPermission	无权限。