Skip to main content
API Explorer|API Explorer
Resource Center/Network Service/Network Service Operations/VPC Firewall Operations
GETVPC Firewall OperationsSince 3.6.0SynchronousAuth Required

QueryFirewallRule

QueryFirewallRule

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoriesListRequired

    See inventories.

    • uuidStringRequired

      The firewall rule UUID.

    • ruleSetUuidStringRequired

      The ruleset UUID.

    • destPortStringRequired

      The destination port.

    • sourcePortStringRequired

      The source port.

    • sourceIpStringRequired

      The source IP address.

    • destIpStringRequired

      The destination IP address.

    • ruleNumberIntegerRequired

      The priority of the rule.

    • allowStatesStringRequired

      The allow status of data packets.

    • tcpFlagStringRequired

      The TCP flag.

    • icmpTypeNameStringRequired

      The ICMP type.

    • isDefaultbooleanRequired

      Indicates whether the rule is applied.

    • isAppliedbooleanRequired

      Indicates whether the rule is expired.

    • expiredbooleanRequired

      Indicates whether the rule is a system rule.

    • descriptionStringRequired

      The detailed description of the rule.

    • createDateTimestampRequired

      The time when the rule was created.

    • lastOpDateTimestampRequired

      The time when the rule was last modified.

    • actionActionTypeRequired

      See action.

      • dropActionTypeRequired

        No description provided.

      • rejectActionTypeRequired

        拒绝。

      • acceptActionTypeRequired

        接受。

    • protocolProtocolTypeRequired

      See protocol.

      • tcp_udpProtocolTypeRequired

        No description provided.

      • allProtocolTypeRequired

        全部。

      • ahProtocolTypeRequired

        No description provided.

      • ax.25ProtocolTypeRequired

        No description provided.

      • dccpProtocolTypeRequired

        No description provided.

      • ddpProtocolTypeRequired

        No description provided.

      • egpProtocolTypeRequired

        No description provided.

      • eigrpProtocolTypeRequired

        No description provided.

      • encapProtocolTypeRequired

        No description provided.

      • espProtocolTypeRequired

        No description provided.

      • etheripProtocolTypeRequired

        No description provided.

      • fcProtocolTypeRequired

        No description provided.

      • ggpProtocolTypeRequired

        No description provided.

      • greProtocolTypeRequired

        No description provided.

      • hipProtocolTypeRequired

        No description provided.

      • hmpProtocolTypeRequired

        No description provided.

      • icmpProtocolTypeRequired

        No description provided.

      • ipdr-cmtpProtocolTypeRequired

        No description provided.

      • idprProtocolTypeRequired

        No description provided.

      • igmpProtocolTypeRequired

        No description provided.

      • igpProtocolTypeRequired

        No description provided.

      • ipProtocolTypeRequired

        来源IP地址。

      • ipcompProtocolTypeRequired

        No description provided.

      • ipencapProtocolTypeRequired

        No description provided.

      • ipipProtocolTypeRequired

        No description provided.

      • isisProtocolTypeRequired

        No description provided.

      • iso-tp4ProtocolTypeRequired

        No description provided.

      • l2tpProtocolTypeRequired

        No description provided.

      • manetProtocolTypeRequired

        No description provided.

      • mpls-in-ipProtocolTypeRequired

        No description provided.

      • ospfProtocolTypeRequired

        No description provided.

      • pimProtocolTypeRequired

        No description provided.

      • pupProtocolTypeRequired

        No description provided.

      • rdpProtocolTypeRequired

        No description provided.

      • rohcProtocolTypeRequired

        No description provided.

      • rspfProtocolTypeRequired

        No description provided.

      • rsvpProtocolTypeRequired

        No description provided.

      • sctpProtocolTypeRequired

        No description provided.

      • skipProtocolTypeRequired

        跳过。

      • stProtocolTypeRequired

        No description provided.

      • tcpProtocolTypeRequired

        No description provided.

      • udpProtocolTypeRequired

        No description provided.

      • udpliteProtocolTypeRequired

        No description provided.

      • vmtpProtocolTypeRequired

        No description provided.

      • vrrpProtocolTypeRequired

        No description provided.

      • wespProtocolTypeRequired

        No description provided.

      • xns-idpProtocolTypeRequired

        No description provided.

      • xtpProtocolTypeRequired

        No description provided.

    • stateFirewallRuleStateRequired

      See state.

      • disableFirewallRuleStateRequired

        禁用。

      • enableFirewallRuleStateRequired

        启用。

Endpoint

GET/zstack/v1/vpcfirewalls/rules

/zstack/v1/vpcfirewalls/rules

Operation ID

QueryFirewallRule

Permalink

Request Example

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

Response Example

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" } ] }

Change History

This API has no change history records yet.

View all change history