You need to enable JavaScript to run this app.
导航
云防火墙
  • 文档首页
    • /
  • 云防火墙

DescribeVpcFirewallList - 获取VPC边界流量控制网关实例列表

最近更新时间：2024.03.28 17:09:33

首次发布时间：2024.03.28 17:09:33

我的收藏

获取VPC边界流量控制网关实例列表

调试

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

DescribeVpcFirewallList

要执行的操作，取值：DescribeVpcFirewallList

Version
String
是

2021-09-06

API的版本，取值：2021-09-06

PageSize
Integer
否

10

分页大小

PageNumber
Integer
否

1

当前页码

TransitRouterId
String
否

tr-*****

中转路由器实例 ID

TransitRouterName
String
否

NTA-*****

中转路由器实例 名称

VpcFirewallId
String
否

vfw-*****

Vpc 防火墙实例 ID

VpcFirewallName
String
否

test

Vpc 防火墙实例 名称

FirewallStatus
Array of String
否

updating

VPC边界防火墙实例状态

  • creating: 创建中
  • deleting: 删除中
  • opened: 已创建
  • closed: 未创建
  • error:错误
  • updating:升级中
RoutePolicyStatus
Array of String
否

opened

引流状态：

  • opened:开启
  • closed:关闭
  • pending:配置中
RouteMode
Array of String
否

["manual"]

路由模式

RegionCode
Array of String
否

cn-*****

地域代码

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
TotalCount
Integer

1

返回数据总数量
当查询数据为空时，且使用python SDK调用时此项为None

PageSize
Integer

1

返回数据的分页大小

PageNumber
Integer

1

返回数据的当前页码

Count
Integer

1

返回数据的实际数量
当查询数据为空时，且使用python SDK调用时此项为None

Data
Array of VpcFirewallStructure

参见结构示例值

返回的vpc防火墙数据

请求示例

POST /DescribeVpcFirewallList HTTP/1.1

{
  "TransitRouterName": "test"
}

返回示例

{
    "ResponseMetadata":{
        "RequestID":"2023*****",
        "Service":"",
        "Region":"",
        "Action":"DescribeVpcFirewallList",
        "Version":"2021-09-06"
    },
    "Result":{
        "TotalCount":1,
        "PageSize":10,
        "PageNumber":1,
        "Count":1,
        "Data":[
            {
                "Region":"cn-*****",
                "TransitRouterId":"tr-*****",
                "TransitRouterName":"NTA-*****",
                "TransitRouterDescription":"",
                "VpcFirewallId":"",
                "VpcFirewallName":"",
                "FirewallStatus":"closed",
                "RoutePolicyStatus":"closed",
                "AttachmentCount":2,
                "ErrMessage":""
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidParameter
Invalid Parameter

无效的参数

400
QueryDbFailed
Query configuration failed

查询数据库失败

400
BadRequest
The http request is bad due to some reason: %s.

由于某些原因，http请求不正确

400
MissingParameter
The required parameter %s is missing.

缺少所需的参数

500
InternalError
Internal service error. %s

内部服务错误