CreateFirewallRule

POST/v1/vpcfirewalls/rules

Operation ID

CreateFirewallRule

Since

3.6.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

params
ObjectRequired
Request body parameter object.
- ruleSetUuid
  StringRequired
  The ruleset UUID.
- action
  StringRequired
  The action taken against data packets.
- protocol
  String
  Optional. The protocol.
- destPort
  String
  Optional. The destination port.
- sourcePort
  String
  Optional. The source port.
- sourceIp
  String
  Optional. The source IP address.
- destIp
  String
  Optional. The destination IP address.
- allowStates
  String
  Optional. The allow status of packets.
- tcpFlag
  String
  Optional. The TCP flag.
- icmpTypeName
  String
  Optional. The ICMP type.
- ruleNumber
  IntegerRequired
  The priority of the rule.
- enableLog
  boolean
  Optional. Specifies whether to enable logging.
- state
  StringRequired
  The action that changes the state of the rule.
- description
  String
  Optional. The detailed description of the rule.
- resourceUuid
  String
  Optional. The rule UUID.
- tagUuids
  List
  Optional. The tag UUIDs.
systemTags
List
Optional. The system tags.
userTags
List
Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

error
ErrorCodeRequired
The error code. If not null, the operation fails, or vice versa. For more information, see error.
- code
  StringRequired
  The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.
- description
  StringRequired
  The brief description of the error.
- details
  StringRequired
  The details about the error.
- elaboration
  StringRequired
  The reserved field. Default value: null.
- opaque
  LinkedHashMapRequired
  The reserved field. Default value: null.
- cause
  ErrorCodeRequired
  The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.
inventory
VpcFirewallRuleInventoryRequired
See inventory.
- uuid
  StringRequired
  The firewall rule UUID.
- ruleSetUuid
  StringRequired
  The ruleset UUID.
- destPort
  StringRequired
  The destination port.
- sourcePort
  StringRequired
  The source port.
- sourceIp
  StringRequired
  The source IP address.
- destIp
  StringRequired
  The destination IP address.
- ruleNumber
  IntegerRequired
  The priority of the rule.
- allowStates
  StringRequired
  Indicates the allow status of packets.
- tcpFlag
  StringRequired
  The TCP flag.
- icmpTypeName
  StringRequired
  The ICMP type.
- isDefault
  booleanRequired
  Indicates whether the rule is applied.
- expired
  booleanRequired
  Indicates whether the rule is expired.
- isApplied
  booleanRequired
  Indicates whether the rule is a system rule.
- description
  StringRequired
  The detailed description of the rule.
- createDate
  TimestampRequired
  The time when the rule was created.
- lastOpDate
  TimestampRequired
  The time when the rule was last modified.
- action
  ActionTypeRequired
  See action.
  drop
  ActionTypeRequired
  The drop.
  reject
  ActionTypeRequired
  The reject.
  accept
  ActionTypeRequired
  The accept.
- protocol
  ProtocolTypeRequired
  See protocol.
  tcp_udp
  ProtocolTypeRequired
  The tcp udp.
  all
  ProtocolTypeRequired
  The all.
  ah
  ProtocolTypeRequired
  The ah.
  ax.25
  ProtocolTypeRequired
  The ax 25.
  dccp
  ProtocolTypeRequired
  The dccp.
  ddp
  ProtocolTypeRequired
  The ddp.
  egp
  ProtocolTypeRequired
  The egp.
  eigrp
  ProtocolTypeRequired
  The eigrp.
  encap
  ProtocolTypeRequired
  The encap.
  esp
  ProtocolTypeRequired
  The esp.
  etherip
  ProtocolTypeRequired
  The etherip.
  fc
  ProtocolTypeRequired
  The fc.
  ggp
  ProtocolTypeRequired
  The ggp.
  gre
  ProtocolTypeRequired
  The gre.
  hip
  ProtocolTypeRequired
  The hip.
  hmp
  ProtocolTypeRequired
  The hmp.
  icmp
  ProtocolTypeRequired
  The icmp.
  ipdr-cmtp
  ProtocolTypeRequired
  The ipdr cmtp.
  idpr
  ProtocolTypeRequired
  The idpr.
  igmp
  ProtocolTypeRequired
  The igmp.
  igp
  ProtocolTypeRequired
  The igp.
  ip
  ProtocolTypeRequired
  The IP address.
  ipcomp
  ProtocolTypeRequired
  The ipcomp.
  ipencap
  ProtocolTypeRequired
  The ipencap.
  ipip
  ProtocolTypeRequired
  The ipip.
  isis
  ProtocolTypeRequired
  The isis.
  iso-tp4
  ProtocolTypeRequired
  The ISO tp 4.
  l2tp
  ProtocolTypeRequired
  The L2 tp.
  manet
  ProtocolTypeRequired
  The manet.
  mpls-in-ip
  ProtocolTypeRequired
  The mpls in IP.
  ospf
  ProtocolTypeRequired
  The ospf.
  pim
  ProtocolTypeRequired
  The pim.
  pup
  ProtocolTypeRequired
  The pup.
  rdp
  ProtocolTypeRequired
  The rdp.
  rohc
  ProtocolTypeRequired
  The rohc.
  rspf
  ProtocolTypeRequired
  The rspf.
  rsvp
  ProtocolTypeRequired
  The rsvp.
  sctp
  ProtocolTypeRequired
  The sctp.
  skip
  ProtocolTypeRequired
  The skip.
  st
  ProtocolTypeRequired
  The st.
  tcp
  ProtocolTypeRequired
  The tcp.
  udp
  ProtocolTypeRequired
  The udp.
  udplite
  ProtocolTypeRequired
  The udplite.
  vmtp
  ProtocolTypeRequired
  The vmtp.
  vrrp
  ProtocolTypeRequired
  The vrrp.
  wesp
  ProtocolTypeRequired
  The wesp.
  xns-idp
  ProtocolTypeRequired
  The xns idp.
  xtp
  ProtocolTypeRequired
  The xtp.
- state
  FirewallRuleStateRequired
  See state.
  disable
  FirewallRuleStateRequired
  Whether the feature is disabled.
  enable
  FirewallRuleStateRequired
  Whether the feature is enabled.

Request Example

curl -X POST '{host}/v1/vpcfirewalls/rules' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "ruleSetUuid": "{ruleSetUuid}",
    "action": "{action}",
    "protocol": "{protocol}",
    "destPort": "{destPort}",
    "sourcePort": "{sourcePort}",
    "sourceIp": "{sourceIp}",
    "destIp": "{destIp}",
    "allowStates": "{allowStates}",
    "tcpFlag": "{tcpFlag}",
    "icmpTypeName": "{icmpTypeName}",
    "ruleNumber": "{ruleNumber}",
    "enableLog": "{enableLog}",
    "state": "{state}",
    "description": "{description}",
    "resourceUuid": "{resourceUuid}",
    "tagUuids": [
      "{tagUuids}"
    ]
  },
  "systemTags": [
    "{systemTags}"
  ],
  "userTags": [
    "{userTags}"
  ]
}'

Response Example

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

VM Instance Operations

Volume Operations

Image Operations

Affinity Group Operations

VM Scheduling Rule Group Operations

Instance Offering Operations

Disk Offering Operations

Auto-Scaling Group Operations

Snapshot Group Operations

SSH Key Operations

Zone Operations

Cluster Operations

Host Operations

GPU Device Operations

Primary Storage Operations

Backup Storage Operations

SAN Storage Operations

Physical Network Operations

PCI Device Operations

USB Redirection Operations

USB Pass-through Operations

SR-IOV Operations

Loongarch SE Operations

Hygon SE Operations

Local Storage Operations

NFS Primary Storage Operations

Shared Mount Point Primary Storage Operations

Ceph Primary Storage Operations

Shared Block Primary Storage Operations

XStor Block Primary Storage Operations

ImageStore Backup Storage Operations

Ceph Backup Storage Operations

iSCSI Server Operations

FC Storage Operations

NVMe Storage Operations

Hardware SDN Controller Operations

L2 Network Operations

L3 Network Operations

Route Resource Operations

VPC Operations

OSPF Operations

Multicast Routing Operations

Policy Routing Operations

vRouter Route Table Operations

Network Service Operations

VPC Firewall Operations

Security Group Operations

VIP Operations

EIP Operations

Port Forwarding Operations

Load Balancing Operations

IPsec Operations

NetFlow APIs

Port Mirroring APIs

Shared Bandwidth Operations

Network Security Policy Schedule Operations

CloudFormation Operations

Bare Metal Management Operations

Installation Service Operations

Elastic Bare Metal Management(Plus)

vCenter Operations

Capacity Management Operations

SNS Operations

Metric Operations

Event Operations

Alarm Operations

Event Subscription Operations

Text Template Operations

Audit Operations

CBT Operations

Backup Service Operations

CDP Operations

Script Library

XML Hook

Job Scheduling APIs

Tag Operations

Migration Service Operations

Organization Operations

Project Operations

Ticket Operations