调用DescribeTrFirewallsV2List获取TR防火墙列表_云防火墙(Cloud Firewall)-阿里云帮助中心

获取TR防火墙列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cloudfirewall:DescribeTrFirewallsV2List

get

*VpcCenTrFirewall

acs:yundun-cloudfirewall::{#accountId}:vpccentrfirewall/{#FirewallId}

无

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	接收消息的语言类型。取值： zh（默认）：中文 en：英文	zh
RegionNo	string	否	转发路由器实例 I 的地域 ID。	cn-hangzhou
FirewallSwitchStatus	string	否	VPC 边界防火墙的状态。取值： opened：已开启 closed：已关闭 notconfigured：表示暂未配置 VPC 边界防火墙 configured：表示已配置 VPC 边界防火墙 creating：表示正在创建 VPC 边界防火墙 opening：表示正在开启 VPC 边界防火墙 deleting：表示正在删除 VPC 边界防火墙说明不设置该参数表示查询所有状态的 VPC 边界防火墙	opened
CurrentPage	integer	否	分页查询时的页码。默认值为 1。	1
PageSize	integer	否	分页查询时，显示的每页数据的最大条数。默认值为 10.	10
FirewallId	string	否	VPC 边界防火墙实例 ID。	vfw-tr-f1799baa9e254651****
FirewallName	string	否	VPC 边界防火墙实例名称。	VPC边界防火墙云企业网企业版
RouteMode	string	否	路由模式。取值： managed：表示自动模式。 manual：表示手动模式。说明不设置该参数表示查询所有路由模式的 VPC 边界防火墙。	managed
CenId	string	否	云企业网实例的 ID。	cen-rig0t5zi96crkl****
TransitRouterId	string	否	转发路由器实例 ID。	tr-uf6egtvyaedvt20xl****

返回参数

名称	类型	描述	示例值
	object
TotalCount	string	返回结果的总条数。	6
RequestId	string	返回结果的请求 ID。	1471E2EC-F706-5F11-A79B-BD583ACB8297
VpcTrFirewalls	array<object>	VPC 边界防火墙列表。
	object	VPC 边界防火墙。
CenId	string	云企业网实例的 ID。	cen-03f8s0z052ka3v****
CenName	string	云企业网实例名称。	cen_swas
CloudFirewallVpcOrderType	string	防火墙 VPC 产生的 TR 费用付费方, 取值: PayByCloudFirewall: 由云防火墙承担费用 PayByCenOwner: 由云企业网实例所属账号承担费用	PayByCenOwner
FirewallId	string	VPC 边界防火墙实例 ID。	vfw-tr-99bc4f0fc88b4d00****
FirewallSwitchStatus	string	VPC 边界防火墙的状态。取值： opened：已开启 closed：已关闭 notconfigured：表示暂未配置 VPC 边界防火墙 configured：表示已配置 VPC 边界防火墙 creating：表示正在创建 VPC 边界防火墙 opening：表示正在开启 VPC 边界防火墙 deleting：表示正在删除 VPC 边界防火墙说明不设置该参数表示查询所有状态的 VPC 边界防火墙	opened
IpsConfig	object	IPS 配置信息。
BasicRules	integer	基础规则开关。取值： 1：开启状态 0：关闭状态	1
EnableAllPatch	integer	虚拟补丁开关。取值： 1：开启状态 0：关闭状态	1
RuleClass	integer	IPS 规则组。取值： 1：宽松规则组。 2：中等规则组。 3：严格规则组。	3
RunMode	integer	IPS 防御模式。取值： 1：拦截模式 0：观察模式	1
OwnerId	integer	VPC 实例所属账号 ID。	171761785151****
PrecheckStatus	string	是否可以自动开墙。取值： passed：可以自动开墙 failed：不可以自动开墙 unknown：未知状态	passed
ProtectedResource	object	已防护的资源列表。
Count	integer	已防护的资源个数。	1
EcrList	array	已防护的 ECR 列表。
	string	已防护的 ECR 列表。	[ "ecr-d6yi3kl5qxmvkz****" ]
PeerTrList	array	已防护的对端 TR 列表。
	string	已防护的对端 TR 列表。	[ "tr-2zegxdvs5f2je81ph****" ]
VbrList	array	已防护的 VBR 列表。
	string	已防护的 VBR 列表。	[ "vbr-2zegxdvs5f2je81ph****" ]
VpcList	array	已防护的 VPC 列表。
	string	已防护的 VPC 列表。	["vpc-2zegxdvs5f2je81ph****"]
VpnList	array	已防护的 VPN 列表。
	string	已防护的 VPN 列表。	[ "vpn-2zegxdvs5f2je81ph****" ]
RegionNo	string	转发路由器实例 I 的地域 ID。	cn-hangzhou
RegionStatus	string	地域开放状态。取值： enable：已开放，表示该地域允许配置 VPC 边界防火墙 disable：未开放，表示该地域不允许配置 VPC 边界防火墙	enable
ResultCode	string	创建 VPC 边界防火墙的操作结果代码。取值： RegionDisable：表示网络实例所在的地域是 VPC 边界防火墙不支持的地域, 不允许创建 VPC 边界防火墙空字符串，表示该网络实例可以正常创建 VPC 边界防火墙	RegionDisable
RouteMode	string	路由模式。取值： managed：表示自动模式 manual：表示手动模式	managed
TransitRouterId	string	转发路由器实例 ID。	tr-2vcmhjs88nil55fvu****
UnprotectedResource	object	未防护的资源列表。
Count	integer	未防护的资源个数。	1
EcrList	array	未防护的 ECR 列表。
	string	未防护的 ECR 列表。	[ "ecr-d6yi3kl5qxmvkz****" ]
PeerTrList	array	未防护的对端 TR 列表。
	string	未防护的对端 TR 列表。	[ "tr-2zegxdvs5f2je81ph****" ]
VbrList	array	未防护的 VBR 列表。
	string	未防护的 VBR 列表。	[ "vbr-2zegxdvs5f2je81ph****" ]
VpcList	array	未防护的 VPC 列表。
	string	未防护的 VPC 列表。	[ "vpc-2zegxdvs5f2je81ph****" ]
VpnList	array	未防护的 VPN 列表。
	string	未防护的 VPN 列表。	[ "vpn-2zegxdvs5f2je81ph****" ]
VpcFirewallName	string	VPC 边界防火墙的实例名称。	VPC边界防火墙
AclConfig	object	ACL 引擎模式。
StrictMode	integer	是否启用严格模式 1：启用严格模式 0：禁用严格模式	1

示例

正常返回示例

JSON格式

{
  "TotalCount": "6",
  "RequestId": "1471E2EC-F706-5F11-A79B-BD583ACB8297",
  "VpcTrFirewalls": [
    {
      "CenId": "cen-03f8s0z052ka3v****",
      "CenName": "cen_swas",
      "CloudFirewallVpcOrderType": "PayByCenOwner",
      "FirewallId": "vfw-tr-99bc4f0fc88b4d00****",
      "FirewallSwitchStatus": "opened",
      "IpsConfig": {
        "BasicRules": 1,
        "EnableAllPatch": 1,
        "RuleClass": 3,
        "RunMode": 1
      },
      "OwnerId": 0,
      "PrecheckStatus": "passed",
      "ProtectedResource": {
        "Count": 1,
        "EcrList": [
          "[\n    \"ecr-d6yi3kl5qxmvkz****\"\n]"
        ],
        "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": [
          "[\n    \"ecr-d6yi3kl5qxmvkz****\"\n]"
        ],
        "PeerTrList": [
          "[\n      \"tr-2zegxdvs5f2je81ph****\"\n]"
        ],
        "VbrList": [
          "[\n      \"vbr-2zegxdvs5f2je81ph****\"\n]"
        ],
        "VpcList": [
          "[\n      \"vpc-2zegxdvs5f2je81ph****\"\n]"
        ],
        "VpnList": [
          "[\n      \"vpn-2zegxdvs5f2je81ph****\"\n]"
        ]
      },
      "VpcFirewallName": "VPC边界防火墙",
      "AclConfig": {
        "StrictMode": 1
      }
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	ErrorUserNotFound	User not found	用户不存在.
400	ErrorUserCredentials	User credentials failed.	未授权，不可访问，请先授权防火墙权限。
400	ErrorDBTxError	A database transaction error occurred.	内部错误：数据库事务错误
400	ErrorDBSelectError	A database select error occurred.	内部错误：数据库查询错误
400	ErrorUnMarshalJSON	internal error.	内部错误

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

变更历史

更多信息，参考变更详情。