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

CreateFirewallRuleSet

CreateFirewallRuleSet

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.

    • nameStringRequired

      The ruleset name.

    • actionTypeString

      Optional. The action taken against data packets.

    • descriptionString

      Optional. The detailed description of the ruleset.

    • resourceUuidString

      Optional. The ruleset UUID.

    • tagUuidsList

      Optional. The tag UUIDs.

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

  • inventoryVpcFirewallRuleSetInventoryRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • isDefaultbooleanRequired

      是否默认。

    • isAppliedbooleanRequired

      Indicates whether the ruleset is applied.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • actionTypeActionTypeRequired

      See actionType.

      • dropActionTypeRequired

        No description provided.

      • rejectActionTypeRequired

        拒绝。

      • acceptActionTypeRequired

        接受。

    • rulesListRequired

      See rules.

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

      • isAppliedbooleanRequired

        Indicates whether the rule is applied.

      • expiredbooleanRequired

        Indicates whether the rule is expired.

      • isDefaultbooleanRequired

        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

POST/zstack/v1/vpcfirewalls/ruleSets

/zstack/v1/vpcfirewalls/ruleSets

Operation ID

CreateFirewallRuleSet

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/vpcfirewalls/ruleSets' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","actionType":"<actionType>","description":"<description>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "name": "name", "actionType": "drop", "description": "example-des", "enableDefaultLog": false, "isDefault": false, "isApplied": true } }

Change History

This API has no change history records yet.

View all change history