云防火墙 CFW-查询防护规则:响应参数
下载云防火墙 CFW用户手册完整版
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
data object |
查询规则列表返回值数据 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
offset |
Integer |
偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
|
limit |
Integer |
每页显示个数，范围为1-1024 |
|
total |
Integer |
查询规则列表总条数 |
|
object_id |
String |
防护对象id，是创建 云防火墙 后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。 |
|
records |
Array of records objects |
查询规则列表记录 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
rule_id |
String |
规则id |
|
address_type |
Integer |
地址类型0 ipv4，1 ipv6 |
|
name |
String |
规则名称 |
|
direction |
Integer |
规则方向0：外到内1：内到外 |
|
action_type |
Integer |
动作0：permit，1：deny |
|
status |
Integer |
规则下发状态 0：禁用，1：启用 |
|
description |
String |
描述 |
|
long_connect_time |
Long |
长连接时长 |
|
long_connect_enable |
Integer |
长连接支持 |
|
long_connect_time_hour |
Long |
长连接时长对应小时 |
|
long_connect_time_minute |
Long |
长连接时长对应分钟 |
|
long_connect_time_second |
Long |
长连接时长秒 |
|
source |
RuleAddressDtoForResponse object |
源地址对象 |
|
destination |
RuleAddressDtoForResponse object |
目的地址对象 |
|
service |
RuleServiceDtoForResponse object |
服务对象 |
|
type |
Integer |
规则类型，0：互联网规则，1：vpc规则，2：nat规则 |
|
created_date |
String |
规则创建时间，例如："2024-08-12 08:40:00" |
|
last_open_time |
String |
规则最后开启时间，例如："2024-08-12 08:40:00" |
|
tag |
TagsVO object |
规则附带标签对象 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
Integer |
地址类型0手工输入，1关联IP地址组，2 域名 ，3地理位置，4域名组，5多对象，6域名组-DNS解析，7域名组-应用型。 |
|
address_type |
Integer |
地址类型0 ipv4，1 ipv6，当type为0手动输入类型时不能为空 |
|
address |
String |
IP地址信息 |
|
address_set_id |
String |
关联IP地址组ID |
|
address_set_name |
String |
地址组名称 |
|
domain_address_name |
String |
域名地址名称 |
|
region_list_json |
String |
规则地域列表json值 |
|
region_list |
Array of IpRegionDto objects |
规则地域列表 |
|
domain_set_id |
String |
域名组id |
|
domain_set_name |
String |
域名组名称 |
|
ip_address |
Array of strings |
IP地址列表 |
|
address_group |
Array of strings |
地址组id列表 |
|
address_group_names |
Array of AddressGroupVO objects |
地址组名称列表 |
|
address_set_type |
Integer |
地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
region_id |
String |
|
|
description_cn |
String |
区域中文描述，仅当区域为中国区域时使用，可通过地域信息表获取。 |
|
description_en |
String |
区域英文描述，仅当区域为非中国区域时使用，可通过地域信息表获取。 |
|
region_type |
Integer |
区域类型，0表示国家，1表示省份，2表示大洲，可通过地域信息表获取。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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（.表示各对象之间层级的区分）获得。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
自定义服务 |
|
service_group |
Array of strings |
服务组id列表 |
|
service_group_names |
Array of ServiceGroupVO objects |
服务组名称列表 |
|
service_set_type |
Integer |
服务组类型，0表示自定义服务组，1表示常用WEB服务，2表示常用远程登录和PING，3表示常用数据库 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
服务成员名称 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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（.表示各对象之间层级的区分）获得。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
