DescribeVpcFirewallList - 获取高速通道防火墙列表 - 云防火墙

查询VPC边界防火墙（防护通过高速通道连接的两个VPC之间的流量）的信息。

接口说明

本接口一般用于分页查询 VPC 边界防火墙的信息。该 VPC 边界防火墙是防护通过高速通道连接两个 VPC 之间的流量。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用将会被限流，这可能影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-cloudfirewall:DescribeVpcFirewallList	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	请求和接收消息的语言类型。取值： zh（默认）：中文。 en：英文。	zh
RegionNo	string	否	VPC 所在的地域 ID。说明关于云防火墙支持地域的详细信息，请参见支持的地域。	cn-hangzhou
VpcId	string	否	VPC 实例 ID。	vpc-8vbwbo90rq0anm6t****
FirewallSwitchStatus	string	否	VPC 边界防火墙的状态。取值： opened：已开启。 closed：已关闭。 notconfigured：表示暂未配置 VPC 边界防火墙。 configured：表示已配置 VPC 边界防火墙。说明不设置该参数表示查询所有状态的 VPC 边界防火墙。	opened
VpcFirewallId	string	否	VPC 边界防火墙的实例 ID。	vfw-m5e7dbc4y****
VpcFirewallName	string	否	VPC 边界防火墙的实例名称。	测试环境防火墙
CurrentPage	string	否	分页查询时，设置当前页面的页码。默认值为 1，表示返回第 1 页数据。	1
PageSize	string	否	分页查询时，设置每页包含 VPC 边界防火墙的数量。默认值为 10，表示每页包含 10 条结果。最大值为 50。	10
MemberUid	string	否	当前阿里云账号的成员账号 UID。	258039427902****
ConnectSubType	string	否	连接子类型。取值： vpc2vpc：高速通道。 vpcpeer：对等连接。	vpcpeer
PeerUid	string	否	对端 VPC 云账号 UID。	258039427902****

返回参数

名称	类型	描述	示例值
	object	VPC 防火墙的列表。
TotalCount	integer	VPC 边界防火墙的总数量。	10
RequestId	string	本次请求的 ID。	850A84D6-0DE4-4797-A1E8-00090125k8g2
VpcFirewalls	array<object>	VPC 边界防火墙的详细信息。
Data	object	VPC 边界防火墙的详细信息。
ConnectType	string	VPC 边界防火墙的互通类型。取值：expressconnect，表示高速通道。	expressconnect
VpcFirewallId	string	VPC 边界防火墙的实例 ID。	vfw-m5e7dbc4y****
RegionStatus	string	地域开放状态。取值： enable：已开放，表示该地域允许配置 VPC 边界防火墙。 disable：未开放，表示该地域不允许配置 VPC 边界防火墙。	enable
Bandwidth	integer	高速通道的带宽规格。单位：Mbps。	2
VpcFirewallName	string	VPC 边界防火墙的实例名称。	测试防火墙
FirewallSwitchStatus	string	VPC 边界防火墙开关的状态。取值： opened：已开启。 closed：已关闭。 notconfigured：表示暂未配置 VPC 边界防火墙。	opened
LocalVpc	object	本端 VPC 的详细信息。
VpcName	string	本端 VPC 的实例名称。	测试用实例
VpcId	string	本端 VPC 的实例 ID。	vpc-8vbwbo90rq0anm6t****
AuthorizationStatus	string	本端 VPC 的授权状态。取值：authorized，表示已授权。	authorized
OwnerId	long	本端 VPC 所属阿里云账号的 UID。	158039427902****
RegionNo	string	本端 VPC 所属地域 ID。	cn-hangzhou
VpcCidrTableList	array<object>	本端 VPC 的网段列表信息。
cidrTable	object	本端 VPC 的网段列表信息。
RouteTableId	string	本端 VPC 的路由表 ID。	vtb-1234
RouteEntryList	array<object>	本端 VPC 的路由条目列表。
routeEntry	object	本端 VPC 的路由条目列表。
NextHopInstanceId	string	本端 VPC 的下一跳实例 ID。	vrt-m5eb5me6c3l5sezae****
DestinationCidr	string	本端 VPC 的目标网段。	192.168.XX.XX/24
PeerVpc	object	对端 VPC 的详细信息。
VpcName	string	对端 VPC 的实例名称。	测试vpc2
VpcId	string	对端 VPC 的实例 ID。	vpc-8vbwbo90rq0anm6t****
AuthorizationStatus	string	对端 VPC 的授权状态。取值：authorized，表示已授权。	authorized
OwnerId	long	对端 VPC 所属的阿里云账号的 UID。	158039427902****
RegionNo	string	对端 VPC 所属地域 ID。	cn-hangzhou
VpcCidrTableList	array<object>	对端 VPC 网段列表信息。
cidrTable	object	对端 VPC 网段列表信息。
RouteTableId	string	对端 VPC 的路由表 ID。	vtb-1256
RouteEntryList	array<object>	对端 VPC 路由条目列表信息。
routeEntry	object	对端 VPC 路由条目列表信息。
NextHopInstanceId	string	对端 VPC 的下一跳实例 ID。	vrt-m5eb5me6c3l5sezae****
DestinationCidr	string	对端 VPC 的目标网段。	192.168.XX.XX/24
IpsConfig	object	IPS 配置信息。
BasicRules	integer	基础规则开关。取值： 1：开启状态。 0：关闭状态。	1
EnableAllPatch	integer	虚拟补丁开关。取值： 1：开启状态。 0：关闭状态。	1
RunMode	integer	IPS 防御模式。取值： 1：拦截模式。 0：观察模式。	0
RuleClass	integer	IPS 规则组。取值： 1：宽松规则组。 2：中等规则组。 3：严格规则组。	1
MemberUid	string	阿里云成员账号的 UID。	258039427902****
ResultCode	string	创建 VPC 边界防火墙的操作结果代码。取值： Unauthorized：表示存在未授权的 VPC, 不允许创建 VPC 边界防火墙。 RegionDisable：表示 VPC 所在的地域是 VPC 边界防火墙不支持的地域, 不允许创建 VPC 边界防火墙。空字符串：表示该网络实例可以正常创建 VPC 边界防火墙。	Unauthorized
ConnectSubType	string	连接子类型。取值： vpc2vpc：高速通道。 vpcpeer：对等连接。	vpcpeer

示例

正常返回示例

JSON格式

{
  "TotalCount": 10,
  "RequestId": "850A84D6-0DE4-4797-A1E8-00090125k8g2",
  "VpcFirewalls": [
    {
      "ConnectType": "expressconnect",
      "VpcFirewallId": "vfw-m5e7dbc4y****",
      "RegionStatus": "enable",
      "Bandwidth": 2,
      "VpcFirewallName": "测试防火墙",
      "FirewallSwitchStatus": "opened",
      "LocalVpc": {
        "VpcName": "测试用实例",
        "VpcId": "vpc-8vbwbo90rq0anm6t****",
        "AuthorizationStatus": "authorized",
        "OwnerId": 0,
        "RegionNo": "cn-hangzhou",
        "VpcCidrTableList": [
          {
            "RouteTableId": "vtb-1234",
            "RouteEntryList": [
              {
                "NextHopInstanceId": "vrt-m5eb5me6c3l5sezae****",
                "DestinationCidr": "192.168.XX.XX/24"
              }
            ]
          }
        ]
      },
      "PeerVpc": {
        "VpcName": "测试vpc2",
        "VpcId": "vpc-8vbwbo90rq0anm6t****",
        "AuthorizationStatus": "authorized",
        "OwnerId": 0,
        "RegionNo": "cn-hangzhou",
        "VpcCidrTableList": [
          {
            "RouteTableId": "vtb-1256",
            "RouteEntryList": [
              {
                "NextHopInstanceId": "vrt-m5eb5me6c3l5sezae****",
                "DestinationCidr": "192.168.XX.XX/24"
              }
            ]
          }
        ]
      },
      "IpsConfig": {
        "BasicRules": 1,
        "EnableAllPatch": 1,
        "RunMode": 0,
        "RuleClass": 1
      },
      "MemberUid": "258039427902****",
      "ResultCode": "Unauthorized",
      "ConnectSubType": "vpcpeer"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	ErrorDBSelectError	A database select error occurred.	内部错误：数据库查询错误
400	ErrorPageNo	Either page number or page size is invalid.	无效的page number 或者 page size
400	ErrorUnmarshalJSON	An error occurred while parsing JSON.	内部错误：JSON解码错误
400	ErrorAliUid	Aliuid invalid.	aliuid无效
400	ErrorFirewallStatus	Firewall status error, please try again later.	防火墙状态错误，请稍后再试

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-10-08	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情
2024-08-15	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情