AI 助理
备案控制台
文档
输入文档关键字查找
首页 云防火墙 云防火墙CFW 开发参考 API参考 API目录 VPC边界防火墙 云企业网（企业版） DescribeTrFirewallsV2List - 获取云企业网（企业版）防火墙列表

DescribeTrFirewallsV2List - 获取云企业网（企业版）防火墙列表

更新时间：
产品详情
相关技术圈
我的收藏

获取TR防火墙列表。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Langstring否

接收消息的语言类型。取值：

  • zh（默认）：中文
  • en：英文
zh
RegionNostring否

转发路由器实例 I 的地域 ID。

cn-hangzhou
FirewallSwitchStatusstring否

VPC 边界防火墙的状态。取值：

  • opened：已开启

  • closed：已关闭

  • notconfigured：表示暂未配置 VPC 边界防火墙

  • configured：表示已配置 VPC 边界防火墙

  • creating：表示正在创建 VPC 边界防火墙

  • opening：表示正在开启 VPC 边界防火墙

  • deleting：表示正在删除 VPC 边界防火墙

说明 不设置该参数表示查询所有状态的 VPC 边界防火墙
opened
CurrentPageinteger否

分页查询时的页码。默认值为 1。

1
PageSizeinteger否

分页查询时，显示的每页数据的最大条数。默认值为 10.

10
FirewallIdstring否

VPC 边界防火墙实例 ID。

vfw-tr-f1799baa9e254651****
FirewallNamestring否

VPC 边界防火墙实例名称。

VPC边界防火墙云企业网企业版
RouteModestring否

路由模式。取值：

  • managed：表示自动模式。

  • manual：表示手动模式。

说明 不设置该参数表示查询所有路由模式的 VPC 边界防火墙。
managed
CenIdstring否

云企业网实例的 ID。

cen-rig0t5zi96crkl****
TransitRouterIdstring否

转发路由器实例 ID。

tr-uf6egtvyaedvt20xl****

返回参数

名称类型描述示例值
object
TotalCountstring

返回结果的总条数。

6
RequestIdstring

返回结果的请求 ID。

1471E2EC-F706-5F11-A79B-BD583ACB8297
VpcTrFirewallsarray<object>

VPC 边界防火墙列表。

VpcTrFirewallsobject

VPC 边界防火墙。

CenIdstring

云企业网实例的 ID。

cen-03f8s0z052ka3v****
CenNamestring

云企业网实例名称。

cen_swas
FirewallIdstring

VPC 边界防火墙实例 ID。

vfw-tr-99bc4f0fc88b4d00****
FirewallSwitchStatusstring

VPC 边界防火墙的状态。取值：

  • opened：已开启

  • closed：已关闭

  • notconfigured：表示暂未配置 VPC 边界防火墙

  • configured：表示已配置 VPC 边界防火墙

  • creating：表示正在创建 VPC 边界防火墙

  • opening：表示正在开启 VPC 边界防火墙

  • deleting：表示正在删除 VPC 边界防火墙

说明 不设置该参数表示查询所有状态的 VPC 边界防火墙
opened
IpsConfigobject

IPS 配置信息。

BasicRulesinteger

基础规则开关。取值：

  • 1：开启状态

  • 0：关闭状态

1
EnableAllPatchinteger

虚拟补丁开关。取值：

  • 1：开启状态
  • 0：关闭状态
1
RuleClassinteger

IPS 规则组。取值：

  • 1：宽松规则组。

  • 2：中等规则组。

  • 3：严格规则组。

3
RunModeinteger

IPS 防御模式。取值：

  • 1：拦截模式
  • 0：观察模式
1
OwnerIdlong

VPC 实例所属账号 ID。

171761785151****
PrecheckStatusstring

是否可以自动开墙。取值：

  • passed：可以自动开墙

  • failed：不可以自动开墙

  • unknown：未知状态

passed
ProtectedResourceobject

已防护的资源列表。

Countinteger

已防护的资源个数。

1
PeerTrListarray

已防护的对端 TR 列表。

peerTrstring

已防护的对端 TR 列表。

[ "tr-2zegxdvs5f2je81ph****" ]
VbrListarray

已防护的 VBR 列表。

vbrstring

已防护的 VBR 列表。

[ "vbr-2zegxdvs5f2je81ph****" ]
VpcListarray

已防护的 VPC 列表。

vpcstring

已防护的 VPC 列表。

["vpc-2zegxdvs5f2je81ph****"]
VpnListarray

已防护的 VPN 列表。

vpnstring

已防护的 VPN 列表。

[ "vpn-2zegxdvs5f2je81ph****" ]
RegionNostring

转发路由器实例 I 的地域 ID。

cn-hangzhou
RegionStatusstring

地域开放状态。取值：

  • enable：已开放，表示该地域允许配置 VPC 边界防火墙

  • disable：未开放，表示该地域不允许配置 VPC 边界防火墙

enable
ResultCodestring

创建 VPC 边界防火墙的操作结果代码。取值：

  • RegionDisable：表示网络实例所在的地域是 VPC 边界防火墙不支持的地域, 不允许创建 VPC 边界防火墙

  • 空字符串，表示该网络实例可以正常创建 VPC 边界防火墙

 RegionDisable
RouteModestring

路由模式。取值：

  • managed：表示自动模式

  • manual：表示手动模式

managed
TransitRouterIdstring

转发路由器实例 ID。

tr-2vcmhjs88nil55fvu****
UnprotectedResourceobject

未防护的资源列表。

Countinteger

未防护的资源个数。

1
PeerTrListarray

未防护的对端 TR 列表。

peerTrstring

未防护的对端 TR 列表。

[ "tr-2zegxdvs5f2je81ph****" ]
VbrListarray

未防护的 VBR 列表。

vbrstring

未防护的 VBR 列表。

[ "vbr-2zegxdvs5f2je81ph****" ]
VpcListarray

未防护的 VPC 列表。

vpcstring

未防护的 VPC 列表。

[ "vpc-2zegxdvs5f2je81ph****" ]
VpnListarray

未防护的 VPN 列表。

vpnstring

未防护的 VPN 列表。

[ "vpn-2zegxdvs5f2je81ph****" ]
VpcFirewallNamestring

VPC 边界防火墙的实例名称。

VPC边界防火墙

示例

正常返回示例

JSON格式

{
  "TotalCount": "6",
  "RequestId": "1471E2EC-F706-5F11-A79B-BD583ACB8297",
  "VpcTrFirewalls": [
    {
      "CenId": "cen-03f8s0z052ka3v****",
      "CenName": "cen_swas",
      "CloudFirewallVpcOrderType": "",
      "FirewallId": "vfw-tr-99bc4f0fc88b4d00****",
      "FirewallSwitchStatus": "opened",
      "IpsConfig": {
        "BasicRules": 1,
        "EnableAllPatch": 1,
        "RuleClass": 3,
        "RunMode": 1
      },
      "OwnerId": 0,
      "PrecheckStatus": "passed",
      "ProtectedResource": {
        "Count": 1,
        "EcrList": [
          ""
        ],
        "PeerTrList": [
          "[\n      \"tr-2zegxdvs5f2je81ph****\"\n]"
        ],
        "VbrList": [
          "[\n      \"vbr-2zegxdvs5f2je81ph****\"\n]"
        ],
        "VpcList": [
          "[\"vpc-2zegxdvs5f2je81ph****\"]"
        ],
        "VpnList": [
          "[\n      \"vpn-2zegxdvs5f2je81ph****\"\n]"
        ]
      },
      "RegionNo": "cn-hangzhou",
      "RegionStatus": "enable",
      "ResultCode": " RegionDisable",
      "RouteMode": "managed",
      "TransitRouterId": "tr-2vcmhjs88nil55fvu****",
      "UnprotectedResource": {
        "Count": 1,
        "EcrList": [
          ""
        ],
        "PeerTrList": [
          "[\n      \"tr-2zegxdvs5f2je81ph****\"\n]"
        ],
        "VbrList": [
          "[\n      \"vbr-2zegxdvs5f2je81ph****\"\n]"
        ],
        "VpcList": [
          "[\n      \"vpc-2zegxdvs5f2je81ph****\"\n]"
        ],
        "VpnList": [
          "[\n      \"vpn-2zegxdvs5f2je81ph****\"\n]"
        ]
      },
      "VpcFirewallName": "VPC边界防火墙"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ErrorUserNotFoundUser not found用户不存在.
400ErrorUserCredentialsUser credentials failed.未授权，不可访问，请先授权防火墙权限。
400ErrorDBTxErrorA database transaction error occurred.内部错误：数据库事务错误
400ErrorDBSelectErrorA database select error occurred.内部错误：数据库查询错误
400ErrorUnMarshalJSONinternal error.内部错误

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

变更历史

变更时间变更内容概要操作
2024-09-06OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
2024-08-15OpenAPI 返回结构发生变更查看变更详情
2023-06-13OpenAPI 返回结构发生变更查看变更详情
上一篇：DescribeTrFirewallsV2Detail - 获取TR防火墙详情下一篇：DescribeTrFirewallsV2RouteList - 获取TR防火墙路由表列表
文档推荐