跳转到主要内容
API Explorer|API Explorer
资源中心/网络服务/网络服务相关接口/防火墙相关接口
GETVPC Firewall Operations起始版本 3.6.0同步需要认证

查询防火墙规则

查询防火墙规则

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

此接口无需请求参数。

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoriesList必填

    详情参考inventories

    • uuidString必填

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

    • ruleSetUuidString必填

      防火墙规则集uuid

    • destPortString必填

      目标端口

    • sourcePortString必填

      源端口

    • sourceIpString必填

      源ip

    • destIpString必填

      目的ip

    • ruleNumberInteger必填

      优先级

    • allowStatesString必填

      检测报文状态

    • tcpFlagString必填

      TCP标志。

    • icmpTypeNameString必填

      icmp类型。

    • isDefaultboolean必填

      是否是过期规则

    • isAppliedboolean必填

      是否为系统规则

    • expiredboolean必填

      是否已在使用

    • descriptionString必填

      资源的详细描述

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • actionActionType必填

      详情参考action

      • dropActionType必填

        暂无描述。

      • rejectActionType必填

        拒绝。

      • acceptActionType必填

        接受。

    • protocolProtocolType必填

      详情参考protocol

      • tcp_udpProtocolType必填

        暂无描述。

      • allProtocolType必填

        全部。

      • ahProtocolType必填

        暂无描述。

      • ax.25ProtocolType必填

        暂无描述。

      • dccpProtocolType必填

        暂无描述。

      • ddpProtocolType必填

        暂无描述。

      • egpProtocolType必填

        暂无描述。

      • eigrpProtocolType必填

        暂无描述。

      • encapProtocolType必填

        暂无描述。

      • espProtocolType必填

        暂无描述。

      • etheripProtocolType必填

        暂无描述。

      • fcProtocolType必填

        暂无描述。

      • ggpProtocolType必填

        暂无描述。

      • greProtocolType必填

        暂无描述。

      • hipProtocolType必填

        暂无描述。

      • hmpProtocolType必填

        暂无描述。

      • icmpProtocolType必填

        暂无描述。

      • ipdr-cmtpProtocolType必填

        暂无描述。

      • idprProtocolType必填

        暂无描述。

      • igmpProtocolType必填

        暂无描述。

      • igpProtocolType必填

        暂无描述。

      • ipProtocolType必填

        来源IP地址。

      • ipcompProtocolType必填

        暂无描述。

      • ipencapProtocolType必填

        暂无描述。

      • ipipProtocolType必填

        暂无描述。

      • isisProtocolType必填

        暂无描述。

      • iso-tp4ProtocolType必填

        暂无描述。

      • l2tpProtocolType必填

        暂无描述。

      • manetProtocolType必填

        暂无描述。

      • mpls-in-ipProtocolType必填

        暂无描述。

      • ospfProtocolType必填

        暂无描述。

      • pimProtocolType必填

        暂无描述。

      • pupProtocolType必填

        暂无描述。

      • rdpProtocolType必填

        暂无描述。

      • rohcProtocolType必填

        暂无描述。

      • rspfProtocolType必填

        暂无描述。

      • rsvpProtocolType必填

        暂无描述。

      • sctpProtocolType必填

        暂无描述。

      • skipProtocolType必填

        跳过。

      • stProtocolType必填

        暂无描述。

      • tcpProtocolType必填

        暂无描述。

      • udpProtocolType必填

        暂无描述。

      • udpliteProtocolType必填

        暂无描述。

      • vmtpProtocolType必填

        暂无描述。

      • vrrpProtocolType必填

        暂无描述。

      • wespProtocolType必填

        暂无描述。

      • xns-idpProtocolType必填

        暂无描述。

      • xtpProtocolType必填

        暂无描述。

    • stateFirewallRuleState必填

      详情参考state

      • disableFirewallRuleState必填

        禁用。

      • enableFirewallRuleState必填

        启用。

请求地址

GET/zstack/v1/vpcfirewalls/rules

/zstack/v1/vpcfirewalls/rules

操作 ID

QueryFirewallRule

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/vpcfirewalls/rules' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "inventories": [ { "ruleSetUuid": "9fe12b6d1b3d38dbab13405722ccf264", "action": "accept", "protocol": "TCP", "destPort": "22", "sourcePort": "22", "sourceIp": "192.168.1.2", "destIp": "192.168.1.1", "ruleNumber": 1001.0, "allowStates": "invalid,new", "tcpFlag": "SYN", "icmpTypeName": "echo-reply", "enableLog": false, "isApplied": true, "expired": false, "state": "disable", "isDefault": false, "description": "example rule des" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史