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

CreateFirewallRuleTemplate

CreateFirewallRuleTemplate

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • actionStringRequired

      动作名称。

    • protocolString

      Optional.

    • nameStringRequired

      The name of the template.

    • destPortString

      Optional.

    • sourcePortString

      Optional.

    • sourceIpString

      Optional.

    • destIpString

      Optional.

    • allowStatesString

      Optional.

    • tcpFlagString

      Optional.

    • icmpTypeNameString

      Optional.

    • ruleNumberIntegerRequired

      规则数量。

    • enableLogboolean

      Optional.

    • stateString

      Optional.

    • descriptionString

      Optional. The detailed description of the template.

    • resourceUuidString

      Optional. The UUID of the template.

    • tagUuidsList

      Optional. The user tags.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

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.

  • inventoryVpcFirewallRuleTemplateInventoryRequired

    See inventory

    • nameStringRequired

      The name of the template.

    • destPortStringRequired

      No description provided.

    • sourcePortStringRequired

      源端口。

    • sourceIpStringRequired

      源IP地址。

    • destIpStringRequired

      No description provided.

    • allowStatesStringRequired

      No description provided.

    • tcpFlagStringRequired

      TCP标志。

    • icmpTypeNameStringRequired

      No description provided.

    • ruleNumberintRequired

      规则数量。

    • enableLogbooleanRequired

      是否日志。

    • isDefaultbooleanRequired

      是否默认。

    • descriptionStringRequired

      The detailed description of the template.

    • createDateTimestampRequired

      The time when the template was created.

    • lastOpDateTimestampRequired

      The time when the template was last modified.

    • accountUuidStringRequired

      The account UUID.

    • uuidStringRequired

      The UUID of the template.

    • 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.

      • pls-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

POST/zstack/v1/vpcfirewalls/rules/template

/zstack/v1/vpcfirewalls/rules/template

Operation ID

CreateFirewallRuleTemplate

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/vpcfirewalls/rules/template' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"action":"<action>","protocol":"<protocol>","name":"<name>","destPort":"<destPort>","sourcePort":"<sourcePort>","sourceIp":"<sourceIp>","destIp":"<destIp>","allowStates":"<allowStates>","tcpFlag":"<tcpFlag>","icmpTypeName":"<icmpTypeName>","ruleNumber":1,"enableLog":true,"state":"<state>","description":"<description>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "action": "accept", "protocol": "TCP", "destPort": "22", "sourcePort": "22", "sourceIp": "192.168.1.2", "destIp": "192.168.1.1", "allowStates": "invalid,new", "tcpFlag": "SYN", "icmpTypeName": "echo-reply", "ruleNumber": 1001.0, "enableLog": false, "state": "disable", "isDefault": false, "description": "example rule des" } }

Change History

This API has no change history records yet.

View all change history