云防火墙 CFW-更新ACL规则:请求参数

时间:2024-12-24 19:48:34

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。可通过如何获取用户Token获取。

表4 请求Body参数

参数

是否必选

参数类型

描述

address_type

Integer

地址类型,0表示ipv4,1表示ipv6

name

String

规则名称

direction

Integer

方向:0表示外到内,1表示内到外,规则type=0(互联网规则)或者type= 2(nat规则)时方向值必填

action_type

Integer

规则动作,0表示允许通行(permit),1表示拒绝通行(deny)

status

Integer

规则启用状态,0表示禁用,1表示启用

applications

Array of strings

规则应用列表,规则应用类型包括:“HTTP”,"HTTPS","TLS1",“DNS”,“SSH”,“MYSQL”,“SMTP”,“RDP”,“RDPS”,“VNC”,“POP3”,“IMAP4”,“SMTPS”,“POP3S”,“FTPS”,“ANY”,“BGP”等。

description

String

规则描述

long_connect_time_hour

Long

长连接时长对应小时

long_connect_time_minute

Long

长连接时长对应分钟

long_connect_time_second

Long

长连接时长秒

long_connect_time

Long

长连接时长

long_connect_enable

Integer

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

source

RuleAddressDto object

源地址传输对象

destination

RuleAddressDto object

目的地址传输对象

service

RuleServiceDto object

服务对象

type

Integer

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

tag

TagsVO object

规则附带标签对象

表5 RuleAddressDto

参数

是否必选

参数类型

描述

type

Integer

地址类型0手工输入,1关联IP地址组,2 域名 ,3地理位置,4域名组,5多对象,6域名组-网络型,7域名组-应用型。

address_type

Integer

地址类型0 ipv4,1 ipv6,当type为0手动输入类型时不能为空

address

String

IP地址信息,当type为0手动输入类型时不能为空

address_set_id

String

关联IP地址组ID,当type为1关联IP地址组类型时不能为空,可通过查询地址组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。

address_set_name

String

关联IP地址组名称,当type为1关联IP地址组类型时不能为空,可通过查询地址组列表接口查询获得,通过返回值中的data.records.name(.表示各对象之间层级的区分)获得。

domain_address_name

String

type为2(域名)和7(应用域名组)具体内容根据type中7修改后的类型名称

region_list_json

String

规则地域列表json值

region_list

Array of IpRegionDto objects

规则地域列表

domain_set_id

String

域名组id,type为4(域名组)或7(域名组-应用型)时不能为空。可通过查询域名组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。

domain_set_name

String

域名组名称,type为4(域名组)或7(域名组-应用型)时不能为空。可通过查询域名组列表接口查询获得,通过返回值中的data.records.name(.表示各对象之间层级的区分)获得。

ip_address

Array of strings

IP地址列表,当type为5(多对象)时不能为空。

address_group

Array of strings

地址组id列表,当type为5(多对象)时不能为空。地址组id可通过查询地址组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。查询条件中query_address_set_type需要设置为0自定义地址组。

address_group_names

Array of AddressGroupVO objects

地址组名称列表

address_set_type

Integer

地址组类型,当type为1(关联IP地址组)时不能为空。0表示自定义地址组,1表示WAF回源IP地址组,2表示DDoS回源IP地址组,3表示NAT64转换地址组

predefined_group

Array of strings

预定义地址组id列表,当type为5(多对象)时不能为空。地址组id可通过查询地址组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。查询条件中query_address_set_type需要设置为1预定义地址组。

表6 IpRegionDto

参数

是否必选

参数类型

描述

region_id

String

区域id,可通过获取账号、 IAM 用户、项目、用户组、区域、委托的名称和ID获取。

description_cn

String

区域中文描述,仅当区域为中国区域时使用,可通过地域信息表获取。

description_en

String

区域英文描述,仅当区域为非中国区域时使用,可通过地域信息表获取。

region_type

Integer

区域类型,0表示国家,1表示省份,2表示大洲,可通过地域信息表获取。

表7 AddressGroupVO

参数

是否必选

参数类型

描述

address_set_type

Integer

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

name

String

关联IP地址组名称,可通过查询地址组列表接口查询获得,通过返回值中的data.records.name(.表示各对象之间层级的区分)获得。

set_id

String

关联IP地址组ID,可通过查询地址组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。

表8 RuleServiceDto

参数

是否必选

参数类型

描述

type

Integer

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

protocol

Integer

协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1,type为0手动类型时不能为空。

protocols

Array of integers

协议列表,协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1,type为0手动类型时不能为空。

source_port

String

源端口

dest_port

String

目的端口

service_set_id

String

服务组id,当type为1(关联IP地址组)时不能为空,可通过获取服务组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。

service_set_name

String

服务组名称,当type为1(关联IP地址组)时不能为空,可通过获取服务组列表接口查询获得,通过返回值中的data.records.name(.表示各对象之间层级的区分)获得。

custom_service

Array of ServiceItem objects

自定义服务

predefined_group

Array of strings

预定义服务组id列表,服务组id可通过获取服务组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。查询条件中query_service_set_type需要设置为1预定义服务组。

service_group

Array of strings

服务组id列表,服务组id可通过获取服务组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。查询条件中query_service_set_type需要设置为0自定义服务组。

service_group_names

Array of ServiceGroupVO objects

服务组名称列表

service_set_type

Integer

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

表9 ServiceItem

参数

是否必选

参数类型

描述

protocol

Integer

协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1,RuleServiceDto.type为0时不能为空。

source_port

String

源端口

dest_port

String

目的端口

description

String

服务成员描述

name

String

服务成员名称

表10 ServiceGroupVO

参数

是否必选

参数类型

描述

name

String

服务组名称

protocols

Array of integers

协议列表,协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1

service_set_type

Integer

服务组类型,0表示自定义服务组,1表示预定义服务组

set_id

String

服务组id,可通过获取服务组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。

表11 TagsVO

参数

是否必选

参数类型

描述

tag_id

String

规则id

tag_key

String

规则标签键

tag_value

String

规则标签值

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