Skip to Content
基础网络 UNet获取防火墙信息 - DescribeFirewall

获取防火墙信息 - DescribeFirewall

简介

获取防火墙组信息

💡 使用方案一：获取某个防火墙的信息。使用方法二：获取某个资源绑定的防火墙信息。使用方法三：获取项目下所有防火墙信息。

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称，当前 API 为 DescribeFirewallYes
PublicKeystring用户公钥，可从 控制台  获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名，参见 签名算法Yes

请求参数

参数名类型描述信息必填
Regionstring地域Yes
ProjectIdstring项目ID。不填写为默认项目，子帐号必须填写No
FWIdstring防火墙ID，默认为返回所有防火墙No
ResourceTypestring绑定防火墙的资源类型，仅获取资源对应防火墙信息时需要。枚举值为：“unatgw”，NAT网关； “uhost”，云主机； “upm”，物理云主机； “hadoophost”，hadoop节点； “fortresshost”，堡垒机； “udhost”，私有专区主机；“udockhost”，容器；“dbaudit”，数据库审计；”uni“，虚拟网卡；“cube”，Cube容器实例；“ulb”，负载均衡实例。No
ResourceIdstring绑定防火墙组的资源ID。No
Limitint返回数据长度，默认为20，最大10000000No
Offsetint列表起始位置偏移量，默认为0No

响应字段

字段名类型描述信息必填
RetCodeint返回状态码，为 0 则为成功返回，非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息，当 RetCode 非 0 时提供详细的描述信息No
DataSetarray[FirewallDataSet]获取的防火墙组详细信息 参见 FirewallDataSetNo
TotalCountint防火墙资源数量No

数据模型

FirewallDataSet

字段名类型描述信息必填
FWIdstring防火墙IDYes
GroupIdstring安全组ID（即将废弃）Yes
Namestring防火墙名称No
Tagstring防火墙业务组No
Remarkstring防火墙备注No
ResourceCountint防火墙绑定资源数量No
CreateTimeint防火墙组创建时间，格式为Unix TimestampNo
Typestring防火墙组类型，枚举值为： “user defined”, 用户自定义防火墙； “recommend web”, 默认Web防火墙； “recommend non web”, 默认非Web防火墙No
Rulearray[FirewallRuleSet]防火墙组中的规则列表，参见 FirewallRuleSetNo

FirewallRuleSet

字段名类型描述信息必填
SrcIPstring源地址No
Prioritystring优先级No
ProtocolTypestring协议类型No
DstPortstring目标端口No
RuleActionstring防火墙动作No
Remarkstring防火墙规则备注No

示例

请求示例

https://api.tnqacloud.com/?Action=DescribeFirewall
&Region=cn-xxx

响应示例

{
  "Action": "DescribeFirewallResponse",
  "DataSet": [
    {
      "CreateTime": 1508472648,
      "FWId": "firewall-XXXX",
      "GroupId": "25575",
      "Name": "non web service recommendation:tcp 22,3389",
      "Remark": "open tcp port:22,3389 and icmp",
      "ResourceCount": 0,
      "Rule": [
        {
          "DstPort": "22",
          "Priority": "HIGH",
          "ProtocolType": "TCP",
          "RuleAction": "ACCEPT",
          "SrcIP": "0.0.0.0/0"
        },
        {
          "DstPort": "3389",
          "Priority": "HIGH",
          "ProtocolType": "TCP",
          "RuleAction": "ACCEPT",
          "SrcIP": "0.0.0.0/0"
        },
        {
          "DstPort": "",
          "Priority": "HIGH",
          "ProtocolType": "ICMP",
          "RuleAction": "ACCEPT",
          "SrcIP": "0.0.0.0/0"
        }
      ],
      "Tag": "Default",
      "Type": "recommend non web"
    }
  ],
  "RetCode": 0,
  "TotalCount": 4
}
获取弹性IP信息 - DescribeEIP获取防火墙绑定资源 - DescribeFirewallResource