DescribeVpcFirewallList - 查询VPC边界防火墙实例列表--云防火墙-火山引擎

文档中心

立即注册

导航

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

最近更新时间：2025.05.29 17:45:45首次发布时间：2024.03.28 17:09:33

查询 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`	实例所属的地域代码，支持多个地域查询。
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，获取方式可参考DescribeVpcFirewallList - 查询 VPC 边界防火墙实例列表。
VpcFirewallName	String	否	`VpcFirewallName`	VPC 边界防火墙实例名称，获取方式可参考DescribeVpcFirewallList - 查询 VPC 边界防火墙实例列表。

返回参数

参数	类型	示例值	描述
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边界防火墙实例操作过程中出现的错误详情。
BypassStatus	String	`false`	`Bypass` 状态，表示VPC边界防火墙实例是否处于旁路状态。 `false`：未启用旁路； `true`：已启用旁路。
InstanceType	Integer	`1`	实例类型 1-普通实例，2-高可用实例，3-GWLB实例，4-混合实例
UpgradeStatus	String	`FAILED`	升级状态 FAILED-升级失败，RUNNING-运行中，UPDATING-升级中，PENDING-等待定时升级
VpcFirewallId	String	`vfw-********`	`VPC` 边界防火墙实例的唯一标识符，用于区分不同的防火墙实例。
FirewallStatus	String	`opened`	`VPC` 边界防火墙实例的当前状态，用于标识实例的生命周期阶段。 `creating`：创建中； `deleting`：删除中； `opened`：已创建； `closed`：未创建； `error`：错误； `updating`：升级中。
TransitRouterId	String	`tr-********`	中转路由器实例的唯一标识符，用于关联和管理 `VPC` 边界防火墙实例的网络路由配置。
UpgradeProgress	Float	`0.5`	升级进度
VpcFirewallName	String	`vfw-example-name`	VPC 边界防火墙实例的名称，用于标识和区分不同的防火墙实例。
RoutePolicyStatus	String	`closed`	引流状态，表示 `VPC` 边界防火墙实例的路由策略当前状态。 `opened`：开启； `closed`：关闭； `pending`：配置中。
TransitRouterName	String	`TransitRouterName`	中转路由器实例的名称，用于标识和区分不同的中转路由器实例。
PeakTrafficWithin7Day	Integer	`10000`	`7` 天内的流量峰值，单位为 `bps`（比特每秒），用于监控和分析 `VPC` 边界防火墙实例的网络流量情况。
TransitRouterDescription	String	`用于连接多个VPC的中转路由器实例`	中转路由器实例的描述信息，用于提供关于中转路由器实例的额外说明或备注信息。

请求示例

POST https://fw_center.volcengineapi.com/?Action=DescribeVpcFirewallList&Version=2021-09-06
{
    "PageSize": 10,
    "PageNumber": 1,
    "TransitRouterId": "tr-*****",
    "TransitRouterName": "NTA-*****",
    "VpcFirewallId": "vfw-*****",
    "VpcFirewallName": "test"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "DescribeVpcFirewallList",
        "Region": "cn-beijing",
        "Service": "fw_center",
        "Version": "2021-09-06",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Count": 1,
        "Data": [
            {
                "Region": "cn-beijing",
                "Bandwidth": 1000,
                "RouteMode": "manual",
                "ErrMessage": "test",
                "BypassStatus": "false",
                "VpcFirewallId": "vfw-********",
                "FirewallStatus": "opened",
                "TransitRouterId": "tr-********",
                "VpcFirewallName": "VpcFirewallName",
                "RoutePolicyStatus": "closed",
                "TransitRouterName": "TransitRouterName",
                "PeakTrafficWithin7Day": 10000,
                "TransitRouterDescription": "TransitRouterDescription"
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1
    }
}

错误码

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