获取防火墙信息-DescribeFirewall

获取防火墙组信息

Request Parameters

Parameter nameTypeDescriptionRequired
Regionstring地域Yes
ProjectIdstring项目ID。不填写为默认项目,子帐号必须填写No
FWIdstring防火墙ID,默认为返回所有防火墙No
ResourceTypestring绑定防火墙组的资源类型,默认为全部资源类型。枚举值为:"unatgw",NAT网关; "uhost",云主机; "upm",物理云主机; "hadoophost",hadoop节点; "fortresshost",堡垒机; "udhost",私有专区主机;"udockhost",容器;"dbaudit",数据库审计.No
ResourceIdstring绑定防火墙组的资源IDNo
Limitstring返回数据长度,默认为20,最大10000000No
Offsetstring列表起始位置偏移量,默认为0No

Response Elements

Parameter nameTypeDescriptionRequired
RetCodeint操作返回码Yes
Actionstring操作名称Yes
DataSetarray获取的防火墙组详细信息 参见 FirewallDataSetNo

FirewallDataSet

Parameter nameTypeDescriptionRequired
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防火墙组中的规则列表,参见 FirewallRuleSetNo

FirewallRuleSet

Parameter nameTypeDescriptionRequired
SrcIPstring源地址No
Prioritystring优先级No
ProtocolTypestring协议类型No
DstPortstring目标端口No
RuleActionstring防火墙动作No
Remarkstring防火墙规则备注No

Request Example

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

Response Example

{
    "Action": "DescribeFirewallResponse",
    "DataSet": [
        {
            "CreateTime": 1508472648,
            "FWId": "firewall-XXXX",
            "GroupId": "25575",
            "Name": "非Web服务器推荐(22,3389)",
            "Remark": "开放22,3389端口和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": 1
}