跳转到主要内容
ZStack
资源中心/网络服务/网络服务相关接口/防火墙相关接口

查询防火墙规则集

查询防火墙规则集

GET/zstack/v1/vpcfirewalls/ruleSets
GET/zstack/v1/vpcfirewalls/ruleSets/{uuid}

操作 ID

QueryFirewallRuleSet

起始版本

3.6.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • q
    String

    查询条件。

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • error
    ErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventories
    List必填

    详情参考inventories

    • uuid
      String必填

      资源的UUID，唯一标示该资源

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • isDefault
      boolean必填

      是否资源默认。

    • isApplied
      boolean必填

      是否资源应用。

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • actionType
      ActionType必填

      详情参考actionType

      • drop
        ActionType必填

        暂无描述。

      • reject
        ActionType必填

        拒绝。

      • accept
        ActionType必填

        接受。

    • rules
      List必填

      详情参考rules

      • uuid
        String必填

        资源的UUID，唯一标示该资源

      • ruleSetUuid
        String必填

        防火墙规则集uuid

      • destPort
        String必填

        目标端口

      • sourcePort
        String必填

        源端口

      • sourceIp
        String必填

        源ip

      • destIp
        String必填

        目的ip

      • ruleNumber
        Integer必填

        优先级

      • allowStates
        String必填

        检测报文状态

      • tcpFlag
        String必填

        TCP标志。

      • icmpTypeName
        String必填

        icmp类型。

      • isApplied
        boolean必填

        是否已在使用

      • expired
        boolean必填

        是否是过期规则

      • isDefault
        boolean必填

        是否为系统规则

      • description
        String必填

        资源的详细描述

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间

      • action
        ActionType必填

        详情参考action

        • drop
          ActionType必填

          暂无描述。

        • reject
          ActionType必填

          拒绝。

        • accept
          ActionType必填

          接受。

      • protocol
        ProtocolType必填

        详情参考protocol

        • tcp_udp
          ProtocolType必填

          暂无描述。

        • all
          ProtocolType必填

          全部。

        • ah
          ProtocolType必填

          安恒。

        • ax.25
          ProtocolType必填

          暂无描述。

        • dccp
          ProtocolType必填

          暂无描述。

        • ddp
          ProtocolType必填

          暂无描述。

        • egp
          ProtocolType必填

          暂无描述。

        • eigrp
          ProtocolType必填

          暂无描述。

        • encap
          ProtocolType必填

          暂无描述。

        • esp
          ProtocolType必填

          暂无描述。

        • etherip
          ProtocolType必填

          暂无描述。

        • fc
          ProtocolType必填

          暂无描述。

        • ggp
          ProtocolType必填

          暂无描述。

        • gre
          ProtocolType必填

          暂无描述。

        • hip
          ProtocolType必填

          暂无描述。

        • hmp
          ProtocolType必填

          暂无描述。

        • icmp
          ProtocolType必填

          暂无描述。

        • ipdr-cmtp
          ProtocolType必填

          暂无描述。

        • idpr
          ProtocolType必填

          暂无描述。

        • igmp
          ProtocolType必填

          暂无描述。

        • igp
          ProtocolType必填

          暂无描述。

        • ip
          ProtocolType必填

          来源IP地址。

        • ipcomp
          ProtocolType必填

          暂无描述。

        • ipencap
          ProtocolType必填

          暂无描述。

        • ipip
          ProtocolType必填

          暂无描述。

        • isis
          ProtocolType必填

          暂无描述。

        • iso-tp4
          ProtocolType必填

          暂无描述。

        • l2tp
          ProtocolType必填

          暂无描述。

        • manet
          ProtocolType必填

          暂无描述。

        • mpls-in-ip
          ProtocolType必填

          暂无描述。

        • ospf
          ProtocolType必填

          暂无描述。

        • pim
          ProtocolType必填

          暂无描述。

        • pup
          ProtocolType必填

          暂无描述。

        • rdp
          ProtocolType必填

          暂无描述。

        • rohc
          ProtocolType必填

          暂无描述。

        • rspf
          ProtocolType必填

          暂无描述。

        • rsvp
          ProtocolType必填

          暂无描述。

        • sctp
          ProtocolType必填

          暂无描述。

        • skip
          ProtocolType必填

          跳过。

        • st
          ProtocolType必填

          暂无描述。

        • tcp
          ProtocolType必填

          暂无描述。

        • udp
          ProtocolType必填

          暂无描述。

        • udplite
          ProtocolType必填

          暂无描述。

        • vmtp
          ProtocolType必填

          暂无描述。

        • vrrp
          ProtocolType必填

          暂无描述。

        • wesp
          ProtocolType必填

          暂无描述。

        • xns-idp
          ProtocolType必填

          暂无描述。

        • xtp
          ProtocolType必填

          暂无描述。

      • state
        FirewallRuleState必填

        详情参考state

        • disable
          FirewallRuleState必填

          是否功能已禁用。

        • enable
          FirewallRuleState必填

          是否功能已启用。