1. 接口描述
接口请求域名： lighthouse.tencentcloudapi.com 。
本接口 (DescribeFirewallTemplates) 用于查询防火墙模板列表。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeFirewallTemplates。 |
| Version | 是 | String | 公共参数，本接口取值：2020-03-24。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| TemplateIds.N | 否 | Array of String | 防火墙模板ID列表。 示例值：["lhft-6brh0ciy"] |
| Filters.N | 否 | Array of Filter | 过滤器列表。 类型：String 必选：否 类型：String 必选：否 类型：String 必选：否 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 100。参数不支持同时指定 TemplateIds 和 Filters。 |
| Offset | 否 | Integer | 偏移量，默认为 0。 示例值：0 |
| Limit | 否 | Integer | 返回数量，默认为 20，最大值为 100。 示例值：10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 模板总数量。 示例值：10 |
| TemplateSet | Array of FirewallTemplate | 防火墙模板列表。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询防火墙模板
查询防火墙模板
输入示例
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFirewallTemplates
<公共请求参数>
{}输出示例
{
"Response": {
"RequestId": "0ac2ecce-f83b-4f5b-80d2-9e88a07e98c0",
"TemplateSet": [
{
"CreatedTime": "2023-06-20T08:04:09Z",
"TemplateId": "lhft-6brh0ciy",
"TemplateName": "test-modify",
"TemplateState": "NORMAL",
"TemplateType": "PRIVATE"
}
],
"TotalCount": 1
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter.InvalidFilterName | Filter参数名称不正确。 |
| UnauthorizedOperation.NoPermission | 无权限。 |