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

文档中心

立即注册

导航

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

最近更新时间：2024.11.25 17:03:53首次发布时间：2024.03.28 17:09:33

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

请求说明

请求方式：POST
请求地址：?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	否	`updating`	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`	路由模式： manual - 手动 auto - 自动
RoutePolicyStatus	Array of String	否	`opened`	引流状态： opened - 开启 closed - 关闭 pending - 配置中
TransitRouterId	String	否	`tr-********`	中转路由器实例 ID。
TransitRouterName	String	否	`TransitRouterName`	中转路由器实例名称。
VpcFirewallId	String	否	`vfw-********`	VPC 边界防火墙实例 ID。
VpcFirewallName	String	否	`VpcFirewallName`	VPC 边界防火墙实例名称。

返回参数

参数	类型	示例值	描述
Count	Integer	`1`	返回数据的实际数量当查询数据为空时，且使用python SDK调用时此项为None
Data	Array of VpcFirewallStructure	`--`	列表详情。
PageNumber	Integer	`1`	返回数据的分页页码
PageSize	Integer	`1`	返回数据的分页大小
TotalCount	Integer	`1`	返回数据总数量当查询数据为空时，且使用python SDK调用时此项为None

VpcFirewallStructure

参数	类型	示例值	描述
Region	String	`cn-beijing`	地域
Bandwidth	Integer	`1000`	授权带宽
RouteMode	String	`manual`	路由模式： manual - 手动 auto - 自动
ErrMessage	String	`test`	错误信息
BypassStatus	String	`false`	Bypass状态
VpcFirewallId	String	`vfw-********`	VPC边界防火墙实例ID
FirewallStatus	String	`opened`	VPC边界防火墙实例状态： creating - 创建中 deleting - 删除中 opened - 已创建 closed - 未创建 error - 错误 updating - 升级中
TransitRouterId	String	`tr-********`	中转路由器实例ID
VpcFirewallName	String	`VpcFirewallName`	VPC边界防火墙实例名称
RoutePolicyStatus	String	`closed`	引流状态： opened - 开启 closed - 关闭 pending - 配置中
TransitRouterName	String	`TransitRouterName`	中转路由器实例名称
PeakTrafficWithin7Day	Integer	`10000`	7天流量峰值,单位bps
TransitRouterDescription	String	`TransitRouterDescription`	中转路由器实例描述信息

请求示例

POST ?Action=DescribeVpcFirewallList&Version=2021-09-06
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240711T081413Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240711/cn-beijing/fw_center/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
  "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
    }
}