创建防火墙规则

POST/v1/vpcfirewalls/rules

操作 ID

CreateFirewallRule

起始版本

3.6.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

params
Object必填
请求体参数结构
- ruleSetUuid
  String必填
  规则集uuid
- action
  String必填
  动作
- protocol
  String
  协议
- destPort
  String
  目标端口
- sourcePort
  String
  源端口
- sourceIp
  String
  源ip
- destIp
  String
  目标ip
- allowStates
  String
  允许状态
- tcpFlag
  String
  可选TCP标志。
- icmpTypeName
  String
  可选icmp类型。
- ruleNumber
  Integer必填
  优先级
- enableLog
  boolean
  是否开启日志
- state
  String必填
  状态
- description
  String
  资源的详细描述
- resourceUuid
  String
  资源UUID
- tagUuids
  List
  标签UUID列表
systemTags
List
系统标签
userTags
List
用户标签

响应状态

200 OK

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

error
ErrorCode必填
错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error
- code
  String必填
  错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001
- description
  String必填
  错误的概要描述
- details
  String必填
  错误的详细信息
- elaboration
  String必填
  保留字段，默认为null
- opaque
  LinkedHashMap必填
  保留字段，默认为null
- cause
  ErrorCode必填
  根错误，引发当前错误的源错误，若无原错误，该字段为null
inventory
VpcFirewallRuleInventory必填
详情参考inventory
- uuid
  String必填
  资源的UUID，唯一标示该资源
- ruleSetUuid
  String必填
  防火墙规则集uuid
- destPort
  String必填
  目标端口
- sourcePort
  String必填
  源端口
- sourceIp
  String必填
  源ip
- destIp
  String必填
  目的ip
- ruleNumber
  Integer必填
  优先级
- allowStates
  String必填
  检测报文状态
- tcpFlag
  String必填
  TCP标志。
- icmpTypeName
  String必填
  icmp类型。
- isDefault
  boolean必填
  是否是过期规则
- expired
  boolean必填
  是否已在使用
- isApplied
  boolean必填
  是否为系统规则
- description
  String必填
  资源的详细描述
- createDate
  Timestamp必填
  创建时间
- lastOpDate
  Timestamp必填
  最后一次修改时间
- action
  ActionType必填
  详情参考action
  drop
  ActionType必填
  暂无描述。
  reject
  ActionType必填
  拒绝。
  accept
  ActionType必填
  接受。
- protocol
  ProtocolType必填
  详情参考protocol
  tcp_udp
  ProtocolType必填
  暂无描述。
  all
  ProtocolType必填
  全部。
  ah
  ProtocolType必填
  安恒。
  ax.25
  ProtocolType必填
  暂无描述。
  dccp
  ProtocolType必填
  暂无描述。
  ddp
  ProtocolType必填
  暂无描述。
  egp
  ProtocolType必填
  暂无描述。
  eigrp
  ProtocolType必填
  暂无描述。
  encap
  ProtocolType必填
  暂无描述。
  esp
  ProtocolType必填
  暂无描述。
  etherip
  ProtocolType必填
  暂无描述。
  fc
  ProtocolType必填
  暂无描述。
  ggp
  ProtocolType必填
  暂无描述。
  gre
  ProtocolType必填
  暂无描述。
  hip
  ProtocolType必填
  暂无描述。
  hmp
  ProtocolType必填
  暂无描述。
  icmp
  ProtocolType必填
  暂无描述。
  ipdr-cmtp
  ProtocolType必填
  暂无描述。
  idpr
  ProtocolType必填
  暂无描述。
  igmp
  ProtocolType必填
  暂无描述。
  igp
  ProtocolType必填
  暂无描述。
  ip
  ProtocolType必填
  来源IP地址。
  ipcomp
  ProtocolType必填
  暂无描述。
  ipencap
  ProtocolType必填
  暂无描述。
  ipip
  ProtocolType必填
  暂无描述。
  isis
  ProtocolType必填
  暂无描述。
  iso-tp4
  ProtocolType必填
  暂无描述。
  l2tp
  ProtocolType必填
  暂无描述。
  manet
  ProtocolType必填
  暂无描述。
  mpls-in-ip
  ProtocolType必填
  暂无描述。
  ospf
  ProtocolType必填
  暂无描述。
  pim
  ProtocolType必填
  暂无描述。
  pup
  ProtocolType必填
  暂无描述。
  rdp
  ProtocolType必填
  暂无描述。
  rohc
  ProtocolType必填
  暂无描述。
  rspf
  ProtocolType必填
  暂无描述。
  rsvp
  ProtocolType必填
  暂无描述。
  sctp
  ProtocolType必填
  暂无描述。
  skip
  ProtocolType必填
  跳过。
  st
  ProtocolType必填
  暂无描述。
  tcp
  ProtocolType必填
  暂无描述。
  udp
  ProtocolType必填
  暂无描述。
  udplite
  ProtocolType必填
  暂无描述。
  vmtp
  ProtocolType必填
  暂无描述。
  vrrp
  ProtocolType必填
  暂无描述。
  wesp
  ProtocolType必填
  暂无描述。
  xns-idp
  ProtocolType必填
  暂无描述。
  xtp
  ProtocolType必填
  暂无描述。
- state
  FirewallRuleState必填
  详情参考state
  disable
  FirewallRuleState必填
  是否功能已禁用。
  enable
  FirewallRuleState必填
  是否功能已启用。

请求示例

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

响应示例

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

云主机相关接口

云盘相关接口

镜像相关接口

亲和组相关接口

云主机调度策略相关接口

计算规格相关接口

云盘规格相关接口

弹性伸缩组相关接口

快照组相关接口

SSH密钥相关接口

区域相关接口

集群相关接口

物理机相关接口

GPU设备相关接口

主存储相关接口

镜像服务器相关接口

SAN存储相关接口

物理网络相关接口

PCI设备相关接口

USB重定向相关接口

USB透传相关接口

SR-IOV相关接口

龙芯SE模块相关接口

海光SE模块相关接口

本地存储相关接口

NFS主存储相关接口

Shared Mount Point主存储相关接口

Ceph主存储相关接口

Shared Block主存储相关接口

XStor Block主存储相关接口

镜像仓库服务器相关接口

Ceph镜像服务器相关接口

iSCSI服务器相关接口

FC存储相关接口

NVMe存储相关接口

SDN设备相关接口

二层网络资源相关接口

三层网络相关接口

路由资源相关接口

VPC相关接口

OSPF相关接口

组播路由相关接口

策略路由相关接口

路由器路由表相关接口

网络服务相关接口

防火墙相关接口

安全组相关接口

虚拟IP相关接口

弹性IP相关接口

端口转发相关接口

负载均衡相关接口

IPsec相关接口

Netflow相关接口

端口镜像相关接口

共享带宽相关接口

安全策略定时计划相关接口

资源编排相关接口

裸金属管理相关接口

安装服务相关接口

弹性裸金属管理(Plus)

vCenter相关接口

容量管理相关接口

管理节点相关接口

通知服务相关接口

时序数据（Metric）

事件（Event）

报警器（Alarm）

事件订阅（Event Subscription）

报警文本模板（Text Template）

审计

CBT相关接口

灾备服务相关接口

持续数据保护(CDP)相关接口

脚本库相关接口

XML Hook相关接口

定时运维相关接口

标签管理相关接口

迁移服务相关接口

组织架构相关接口

项目管理相关接口