操作指南

API 文档

查询防火墙规则模板

最近更新时间:2022-06-14 06:13:36

我的收藏

1. 接口描述

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

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

默认接口请求频率限制:10次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeFirewallRulesTemplate。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的防火墙规则数量。
FirewallRuleSet Array of FirewallRuleInfo 防火墙规则详细信息列表。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

https://lighthouse.tencentcloudapi.com/?Action=DescribeFirewallRulesTemplate
&<公共请求参数>

输出示例

{
  "Response": {
    "FirewallRuleSet": [
      {
        "Action": "ACCEPT",
        "AppType": "Windows登录(3389)",
        "CidrBlock": "0.0.0.0/0",
        "FirewallRuleDescription": "放通Windows远程登录",
        "Port": "3389",
        "Protocol": "TCP"
      },
      {
        "Action": "ACCEPT",
        "AppType": "Linux登录(22)",
        "CidrBlock": "0.0.0.0/0",
        "FirewallRuleDescription": "放通Linux SSH登录",
        "Port": "22",
        "Protocol": "TCP"
      },
      {
        "Action": "ACCEPT",
        "AppType": "HTTP(80)",
        "CidrBlock": "0.0.0.0/0",
        "FirewallRuleDescription": "放通Web服务HTTP(80),如 Apache、Nginx",
        "Port": "80",
        "Protocol": "TCP"
      },
      {
        "Action": "ACCEPT",
        "AppType": "HTTPS(443)",
        "CidrBlock": "0.0.0.0/0",
        "FirewallRuleDescription": "放通Web服务HTTPS(443),如 Apache、Nginx",
        "Port": "443",
        "Protocol": "TCP"
      },
      {
        "Action": "ACCEPT",
        "AppType": "MySQL(3306)",
        "CidrBlock": "0.0.0.0/0",
        "FirewallRuleDescription": "放通MySQL服务(3306)",
        "Port": "3306",
        "Protocol": "TCP"
      },
      {
        "Action": "ACCEPT",
        "AppType": "SQL Server(1433)",
        "CidrBlock": "0.0.0.0/0",
        "FirewallRuleDescription": "放通SQL Server服务(1433)",
        "Port": "1433",
        "Protocol": "TCP"
      },
      {
        "Action": "ACCEPT",
        "AppType": "全部TCP",
        "CidrBlock": "0.0.0.0/0",
        "FirewallRuleDescription": "放通全部TCP",
        "Port": "1-65535",
        "Protocol": "TCP"
      },
      {
        "Action": "ACCEPT",
        "AppType": "全部UDP",
        "CidrBlock": "0.0.0.0/0",
        "FirewallRuleDescription": "放通全部UDP",
        "Port": "1-65535",
        "Protocol": "UDP"
      },
      {
        "Action": "ACCEPT",
        "AppType": "Ping-ICMP",
        "CidrBlock": "0.0.0.0/0",
        "FirewallRuleDescription": "放通Ping",
        "Port": "ALL",
        "Protocol": "ICMP"
      },
      {
        "Action": "ACCEPT",
        "AppType": "ALL",
        "CidrBlock": "0.0.0.0/0",
        "FirewallRuleDescription": "放通全部TCP、UDP、ICMP(Ping)以及GRE",
        "Port": "ALL",
        "Protocol": "ALL"
      }
    ],
    "RequestId": "b9fdb7cc-8afa-4fae-9062-73e41d06f7d3",
    "TotalCount": 10
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
UnauthorizedOperation.NoPermission 无权限。
目录