云防火墙 CFW-创建ACL规则:请求参数

时间:2024-07-26 15:35:48

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

表4 请求Body参数

参数

是否必选

参数类型

描述

object_id

String

防护对象id,是创建 云防火墙 后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。

type

Integer

规则type,0:互联网规则,1:vpc规则,2:nat规则

枚举值:

  • 0
  • 1
  • 2

rules

Array of rules objects

rules

表5 rules

参数

是否必选

参数类型

描述

name

String

规则名称

sequence

OrderRuleAclDto object

规则序列

address_type

Integer

地址类型,0 ipv4,1 ipv6,2 domain

枚举值:

  • 0
  • 1
  • 2

action_type

Integer

动作0:permit,1:deny

status

Integer

规则下发状态 0:禁用,1:启用

枚举值:

  • 0
  • 1

applications

Array of strings

应用列表

applicationsJsonString

String

应用列表转化json字符串

long_connect_time

Long

长连接时长

long_connect_time_hour

Long

长连接时长小时

long_connect_time_minute

Long

长连接时长分钟

long_connect_time_second

Long

长连接时长秒

long_connect_enable

Integer

是否支持长连接,0表示不支持长连接,1表示支持长连接

枚举值:

  • 0
  • 1

description

String

描述

direction

Integer

方向:0表示外到内,1表示内到外【说明:规则type=0:互联网规则 | 2:nat规则时方向值必填】

枚举值:

  • 0
  • 1

source

RuleAddressDtoForRequest object

源地址传输对象

destination

RuleAddressDtoForRequest object

目的地址传输对象

service

RuleServiceDto object

服务对象

tag

TagsVO object

标签显示值

表6 OrderRuleAclDto

参数

是否必选

参数类型

描述

dest_rule_id

String

目标规则id,添加规则位于此规则之后,非置顶时不能为空,置顶时为空

top

Integer

是否置顶,0代表非置顶,1代表置顶

bottom

Integer

是否置底,0代表非置底,1代表置底

表7 RuleAddressDtoForRequest

参数

是否必选

参数类型

描述

type

Integer

类型0手工输入,1关联IP地址组,2 域名 ,3地理位置,4域名组,5多对象,6域名组-DNS解析,7域名组-URL过滤。

address_type

Integer

地址类型0 ipv4,1 ipv6

address

String

IP,手动类型不能为空,自动及domain类型为空

address_set_id

String

关联IP地址组ID,自动类型不能为空,手动类型合domain类型为空

address_set_name

String

地址组名称

domain_address_name

String

域名地址名称,域名类型时不能为空,手动类型及自动类型时为空

region_list_json

String

规则region列表json值

region_list

Array of IpRegionDto objects

规则region列表

domain_set_id

String

域名组id

domain_set_name

String

域名组名称

ip_address

Array of strings

IP地址列表

address_set_type

Integer

地址组类型,0表示自定义地址组,1表示WAF回源IP地址组,2表示DDoS回源IP地址组,3表示NAT64转换地址组

predefined_group

Array of strings

预定义地址组列表

address_group

Array of strings

地址组列表

表8 IpRegionDto

参数

是否必选

参数类型

描述

region_id

String

区域id

description_cn

String

中文描述

description_en

String

英文描述

region_type

Integer

区域类型,0表示国家,1表示省份,2表示大洲

表9 RuleServiceDto

参数

是否必选

参数类型

描述

type

Integer

服务输入类型,0为手动输入类型,1为自动输入类型

protocol

Integer

协议类型:TCP为6, UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空,自动类型为空

protocols

Array of integers

协议列表,协议类型:TCP为6, UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空,自动类型为空

source_port

String

源端口

dest_port

String

目的端口

service_set_id

String

服务组id,手动类型为空,自动类型为非空

service_set_name

String

服务组名称

custom_service

Array of ServiceItem objects

自定义服务

predefined_group

Array of strings

预定义服务组列表

service_group

Array of strings

服务组列表

service_group_names

Array of ServiceGroupVO objects

服务组名称列表

service_set_type

Integer

服务组类型,0表示自定义服务组,1表示常用WEB服务,2表示常用远程登录和PING,3表示常用数据库

表10 ServiceItem

参数

是否必选

参数类型

描述

protocol

Integer

协议类型:TCP为6, UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空,自动类型为空

source_port

String

源端口

dest_port

String

目的端口

description

String

服务成员描述

name

String

服务成员名称

表11 ServiceGroupVO

参数

是否必选

参数类型

描述

name

String

服务组名称

protocols

Array of integers

协议列表

service_set_type

Integer

服务组类型,0表示自定义服务组,1表示常用WEB服务,2表示常用远程登录和PING,3表示常用数据库

set_id

String

服务组ID

表12 TagsVO

参数

是否必选

参数类型

描述

tag_id

String

标签id

tag_key

String

标签键

tag_value

String

标签值

support.huaweicloud.com/api-cfw/AddAclRule.html