文档

DescribeFirewallTemplates - 查询防火墙模板

更新时间:

查询防火墙模板的信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
swas-open:DescribeFirewallTemplateslist
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

指定的轻量应用服务器实例所属的地域 ID。 您可以调用 ListRegions 查看支持的阿里云地域列表。

cn-hangzhou
FirewallTemplateIdarray

防火墙模板 ID。

string

防火墙模板 ID。

ft-bcf1a7hrdq717****
Namestring

防火墙模板名称。

testName
PageNumberinteger

当前页码。

起始值:1。

默认值:1。

1
PageSizeinteger

分页查询时设置的每页行数。默认值:20。

20

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

30637AD6-D977-4833-A54C-CC89483E****
TotalCountinteger

防火墙模板总数。

10
PageNumberinteger

当前页码。

起始值:1。

默认值:1。

1
PageSizeinteger

分页查询时设置的每页行数。默认值:20。

20
FirewallTemplatesarray<object>

防火墙模板信息。

object

防火墙模板信息。

FirewallTemplateIdstring

防火墙模板 ID。

ft-bcf1a7hrdq717****
CreationTimestring

防火墙模板创建时间。按照ISO 8601标准表示,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2024-04-10T02:10:14Z
Namestring

防火墙模板名称。

test
Descriptionstring

防火墙模板描述信息。

test
CreateTimestring

防火墙模板创建时间。按照ISO 8601标准表示,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

说明 +8 小时后是控制台上显示的到期时间。
2024-04-29T02:01:38Z
FirewallTemplateRulesarray<object>

防火墙模板规则。

object

防火墙模板规则。

FirewallTemplateRuleIdstring

防火墙模板规则 ID。

eeea34d9867b4d55a4ff8d5fcfbd****
RuleProtocolstring

传输层协议。可能值:

  • TCP:TCP 协议。
  • UDP:UDP 协议。
  • TCP+UDP:TCP 和 UDP 协议。
  • ICMP:ICMP 协议。
TCP
Portstring

端口范围。端口的取值范围为 1~65535。使用正斜线(/)隔开起始端口和终止端口,例如:1024/1055表示端口范围为 1024~1055。

说明 如果您设置的是 ICMP 协议,端口只能为-1/-1。
8080
SourceCidrIpstring

需要设置访问权限的源端 IPv4 CIDR 地址段。支持 CIDR 格式和 IPv4 格式的 IP 地址范围。

119.145.XX.XX
Remarkstring

防火墙规则的备注。

test

示例

正常返回示例

JSON格式

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "TotalCount": 10,
  "PageNumber": 1,
  "PageSize": 20,
  "FirewallTemplates": [
    {
      "FirewallTemplateId": "ft-bcf1a7hrdq717****",
      "CreationTime": "2024-04-10T02:10:14Z",
      "Name": "test",
      "Description": "test",
      "CreateTime": "2024-04-29T02:01:38Z",
      "FirewallTemplateRules": [
        {
          "FirewallTemplateRuleId": "eeea34d9867b4d55a4ff8d5fcfbd****",
          "RuleProtocol": "TCP",
          "Port": "8080",
          "SourceCidrIp": "119.145.XX.XX",
          "Remark": "test"
        }
      ]
    }
  ]
}

错误码

访问错误中心查看更多错误码。