查询 VPC 边界防火墙实例列表。

请求说明

请求方式：POST

请求地址：https://fw-center.volcengineapi.com/?Action=DescribeVpcFirewallList&Version=2021-09-06

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	DescribeVpcFirewallList	接口名称。当前 API 的名称为 DescribeVpcFirewallList。
Version	String	是	2021-09-06	接口版本。当前 API 的版本为 2021-09-06。

Body

参数	类型	是否必选	示例值	描述
FirewallStatus	Array of String	否	opened	VPC边界防火墙实例的状态，取值如下所示。 creating：创建中； deleting：删除中； opened：已创建； closed：未创建； error：错误； updating：升级中。
PageNumber	Integer	否	1	分页页码，默认值为 1。
PageSize	Integer	否	10	分页大小，默认值为 10。
RegionCode	Array of String	否	cn-beijing	精确查询资产所在的地域，支持多选。例如 cn-beijing 表示北京地域，更多地域信息可参考地域和可用区列表。
RouteMode	Array of String	否	manual	VPC 边界防火墙实例的路由模式，支持多选。 manual：手动模式； auto：自动模式。
RoutePolicyStatus	Array of String	否	["opened"]	引流状态，表示 VPC 边界防火墙实例的流量引流状态，支持多选。 opened：开启； closed：关闭； pending：配置中。
TransitRouterId	String	否	tr-********	中转路由器实例的唯一标识符，用于指定查询的特定中转路由器实例。
TransitRouterName	String	否	TransitRouterName	中转路由器实例的名称，用于标识特定的中转路由器实例。
VpcFirewallId	String	否	vfw-********	VPC边界防火墙实例ID。
VpcFirewallName	String	否	VpcFirewallName	VPC 边界防火墙实例名称。
CloudFirewallId	String	否	CloudFirewall********	VPC 防火墙实例 ID。
OrderDir	String	否	asc	按优先级排序，支持的取值如下所示。 asc：升序，即优先级字段从小到大，优先级顺序从高到低 desc：降序，即优先级字段从大到小，优先级顺序从低到高
ProjectName	String	否	default	项目名称，用于标识 VPC 边界防火墙实例所属的项目。默认值为 default。

返回参数

参数	类型	示例值	描述
Count	Integer	1	返回数据的实际数量。当查询数据为空且使用 python SDK 调用时，此项为 None。
Data	Array of VpcFirewallDetail	--	列表详情。
PageNumber	Integer	1	返回数据的分页页码，表示当前查询结果所在的页码。
PageSize	Integer	10	分页大小，表示每页返回的记录数，默认值为 10。
TotalCount	Integer	12	返回数据的总数量，当查询数据为空且使用 Python SDK 调用时此项为 None。

VpcFirewallDetail

参数	类型	示例值	描述
Region	String	cn-beijing	NAT 边界防火墙实例所属的地域，用于标识实例所在的物理位置。
Bandwidth	Integer	1000	授权带宽，表示VPC边界防火墙实例的带宽限制。
RouteMode	String	manual	路由模式，表示VPC边界防火墙实例的路由配置方式。 manual：手动配置路由； auto：自动配置路由。
ErrMessage	String	实例创建失败，资源不足	错误信息，用于描述VPC边界防火墙实例操作过程中出现的错误详情。
VersionCode	String	v1.2.3	当前 VPC边界防火墙实例的版本号，用于标识防火墙实例的软件版本。
BypassStatus	String	false	Bypass 状态，表示VPC边界防火墙实例是否处于旁路状态。 false：未启用旁路； true：已启用旁路。
InstanceType	Integer	1	VPC 边界防火墙实例的类型，用于区分不同功能和特性的防火墙实例。支持的取值如下所示。 1：普通实例； 2：高可用实例； 3：GWLB 实例； 4：混合实例。
UpgradeStatus	String	UPDATING	VPC 边界防火墙实例的升级状态，用于标识当前实例的升级进度和结果。支持的取值如下所示。 FAILED：升级失败； RUNNING：运行中； UPDATING：升级中； PENDING：等待定时升级。
VpcFirewallId	String	vfw-********	VPC边界防火墙实例的唯一标识符，用于区分不同的防火墙实例。
FirewallStatus	String	opened	VPC 边界防火墙实例的当前状态，用于标识实例的生命周期阶段。 creating：创建中； deleting：删除中； opened：已创建； closed：未创建； error：错误； updating：升级中。
ScheduleEndTime	Integer	1746513256	定时升级计划的结束时间，使用 Unix 时间戳格式表示。该字段用于标识 VPC边界防火墙实例升级任务的预定结束时间。
TransitRouterId	String	tr-2ze3xysf3j4s5d6f	中转路由器实例的唯一标识符，用于关联和管理 VPC边界防火墙实例的网络路由配置。
UpgradeProgress	Float	0.75	VPC 边界防火墙实例的升级进度，表示当前升级任务的完成比例，取值范围为 0 到 1。
VpcFirewallName	String	vfw-example-name	VPC 边界防火墙实例的名称，用于标识和区分不同的防火墙实例。
RoutePolicyStatus	String	closed	引流状态，表示 VPC 边界防火墙实例的路由策略当前状态。 opened：开启； closed：关闭； pending：配置中。
ScheduleStartTime	Integer	1746513256	定时升级计划的开始时间，使用 Unix 时间戳格式表示。该字段用于标识 VPC边界防火墙实例升级任务的预定开始时间。
TransitRouterName	String	TransitRouterName	中转路由器实例的名称，用于标识和区分不同的中转路由器实例。
UpgradeVersionCode	String	v2.0.0	待升级的目标版本号，表示 VPC边界防火墙实例计划升级到的软件版本。
PeakTrafficWithin7Day	Integer	10000	7 天内的流量峰值，单位为 bps（比特每秒），用于监控和分析 VPC边界防火墙实例的网络流量情况。
TransitRouterDescription	String	用于连接多个VPC的中转路由器实例	中转路由器实例的描述信息，用于提供关于中转路由器实例的额外说明或备注信息。

请求示例

返回示例

错误码

您可访问公共错误码，获取更多错误码信息。

云防火墙