云防火墙 CFW-获取东西向防火墙信息:响应参数

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

data

GetEastWestFirewallResponseBody object

获取东西向防火墙列表返回data

表5 GetEastWestFirewallResponseBody

参数

参数类型

描述

object_id

String

防护对象id,是创建 云防火墙 后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口获得,通过返回值中的data.records.protect_objects.object_id(.表示各对象之间层级的区分)获得,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。此处仅取type为1的防护对象id,可通过data.records.protect_objects.type(.表示各对象之间层级的区分)获得。

project_id

String

项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式

status

Integer

防护状态:0 已开启防护, 1 未开启防护

firewall_associated_subnets

Array of SubnetInfo objects

云防火墙关联子网信息

er

ErInstance object

出方向关联企业路由器信息

inspection_vpc

VpcDetail object

引流vpc信息

protect_infos

Array of EwProtectResourceInfo objects

东西向防护资源信息

total

Integer

防护VPC总数

offset

Integer

偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0

limit

Integer

每页显示个数,范围为1-1024

mode

String

防护模式,值为er

表6 SubnetInfo

参数

参数类型

描述

availability_zone

String

子网所在的可用区标识,从终端节点获取,参考终端节点

cidr

String

功能说明:虚拟私有云下可用子网的范围

取值范围:

10.0.0.0/8~24

172.16.0.0/12~24

192.168.0.0/16~24

不指定cidr时,默认值为空

约束:必须是cidr格式,例如:192.168.0.0/16

name

String

子网名称

id

String

子网id

gateway_ip

String

子网的网关,取值范围为子网网段cidr中的ip地址

vpc_id

String

创建vpc产生的uuid

ipv6_enable

Boolean

是否支持ipv6,boolean值为true表示是,false表示否

表7 ErInstance

参数

参数类型

描述

id

String

ER ID,创建ER时产生的ID

name

String

ER名称

project_id

String

项目ID,可以从调API处获取,也可以从控制台获取。项目ID获取方式

attachment_id

String

企业路由器连接id,该连接用于连接防火墙和企业路由器,此字段可在通过id在ER界面查询指定er后在管理连接界面查询连接了解连接具体情况。

表8 VpcDetail

参数

参数类型

描述

id

String

创建引流VPC产生的随机UUID

name

String

引流VPC名称

cidr

String

功能说明:虚拟私有云下可用子网的范围 取值范围: 10.0.0.0/8~24 172.16.0.0/12~24 192.168.0.0/16~24 不指定cidr时,默认值为空 约束:必须是cidr格式,例如:192.168.0.0/16

表9 EwProtectResourceInfo

参数

参数类型

描述

protected_resource_type

Integer

防护资源类型:0 VPC,1 VGW,2 VPN,3 PEERING

protected_resource_name

String

防护资源名称

protected_resource_id

String

防护资源id

protected_resource_nat_name

String

防护资源nat网关名称,专业版防火墙支持NAT规则,此字段表示防护连接的NAT的名称。

protected_resource_nat_id

String

防护资源nat网关id,专业版防火墙支持NAT规则,此字段表示防护连接的NAT的id。

protected_resource_project_id

String

防火墙支持跨账户防护,此处为防护资源租户id

protected_resource_mode

String

防护资源模式,为er

status

Integer

防护资源的防护状态,0表示已关联,1表示未关联。

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

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