AI 助理
文档备案控制台
官方文档
首页 云防火墙 云防火墙CFW 开发参考 API参考 API目录 防火墙开关 VPC边界防火墙 云企业网（企业版） DescribeTrFirewallsV2Detail - 获取TR防火墙详情

DescribeTrFirewallsV2Detail - 获取TR防火墙详情

更新时间：
复制 MD 格式
产品详情
我的收藏

获取TR防火墙详情。

接口说明

查询企业版转发路由器 VPC 边界防火墙详情。FirewallId 可先通过 DescribeTrFirewallsV2List 查询；若尚未创建防火墙，需先在 CEN 产品中准备企业版转发路由器，再调用 CreateTrFirewallV2 创建并取得 FirewallId。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cloudfirewall:DescribeTrFirewallsV2Detail

get

*VpcCenTrFirewall

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

 无 无

请求参数

名称

类型

必填

描述

示例值
Lang

string

否

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

  • zh（默认）：中文

  • en：英文

zh
FirewallId

string

否

VPC 边界防火墙实例 ID。本参数必填，缺失时返回 ErrorMissingFirewallId（-360444，firewall id is required）。

说明

可通过 DescribeTrFirewallsV2List 查询已有的 FirewallId（格式为 vfw-tr-*）；若尚未创建，需先在 CEN 产品中创建企业版转发路由器，再调用 CreateTrFirewallV2。

vfw-tr-a5a6b89f46764928****

返回参数

名称

类型

描述

示例值

object

CenId

string

云企业网实例 ID。

cen-37nddhri7jf0d2****
FirewallAttachmentZone

string

防火墙连接使用的可用区 ID。

cn-hangzhou-h
FirewallDescription

string

防火墙描述。

vpc-firewall-description
FirewallEniId

string

防火墙 ENI ID。

eni-uf621u00nafypeex****
FirewallEniVpcId

string

防火墙 ENI 所在的 VPC ID。

vpc-2zeppcci782zeh2bk****
FirewallEniVswitchId

string

防火墙 ENI 所在的 VSWITCH ID。

vsw-uf6ptq1kl1c1d9pw9****
FirewallId

string

VPC 边界防火墙实例 ID。

vfw-tr-9c7c711abdfa4d80****
FirewallName

string

VPC 边界防火墙实例名称。

cloudfirewall-manual
FirewallServiceMode

string

TR 防火墙服务部署模式。 取值：PrimaryStandby（主备模式）、MultiPrimary（双活模式）。

PrimaryStandby
FirewallServiceZones

array

TR 防火墙服务使用的可用区 ID 列表。

string

TR 防火墙服务使用的单个可用区 ID。

cn-hangzhou-i
FirewallStatus

string

防火墙状态。取值：

  • Creating：创建中

  • Deleting：删除中

  • Ready：就绪

Ready
FirewallSubnetCidr

string

自动模式下防火墙 VPC 中存放防火墙 ENI 的子网网段。

10.0.1.0/24
FirewallSwitchStatus

string

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

  • opened：已开启

  • closed：已关闭

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

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

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

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

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

说明

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

opened
FirewallVpcCidr

string

自动模式下防火墙 VPC 网段。

10.0.0.0/16
RegionNo

string

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

cn-shanghai
RequestId

string

返回结果的请求 ID。

7E53A7FB-3EB9-5E33-8E50-B8F417D1E02B
RouteMode

string

路由模式。取值：

  • managed：表示自动模式

  • manual：表示手动模式

managed
TrAttachmentId

string

自动模式下防火墙 VPC 中用于连接 TR 的关联 Id。

tr-attach-r1llaxxeha71jsm36v
TrAttachmentMasterCidr deprecated

string

自动模式下防火墙 VPC 中用于连接 TR 的子网主用网段。

10.0.2.0/24
TrAttachmentMasterZone deprecated

string

自动模式下防火墙 VPC 中用于连接 TR 的子网主用可用区。

cn-hangzhou-h
TrAttachmentSlaveCidr deprecated

string

自动模式下防火墙 VPC 中用于连接 TR 的子网备用网段。

10.0.3.0/24
TrAttachmentSlaveZone deprecated

string

自动模式下防火墙 VPC 中用于连接 TR 的子网备用可用区。

cn-hangzhou-i
TrAttachmentZones

array<object>

TR 连接可用区及交换机网段信息列表。

object

VSwitchCidr

string

TR 连接交换机的网段。

10.0.2.0/24
VSwitchZoneId

string

TR 连接交换机所属的可用区 ID。

cn-hangzhou-h
TransitRouterId

string

转发路由器实例 ID。

tr-wz9y8sgug8b1xb416****

示例

正常返回示例

JSON格式

{
  "CenId": "cen-37nddhri7jf0d2****",
  "FirewallAttachmentZone": "cn-hangzhou-h",
  "FirewallDescription": "vpc-firewall-description",
  "FirewallEniId": "eni-uf621u00nafypeex****",
  "FirewallEniVpcId": "vpc-2zeppcci782zeh2bk****",
  "FirewallEniVswitchId": "vsw-uf6ptq1kl1c1d9pw9****",
  "FirewallId": "vfw-tr-9c7c711abdfa4d80****",
  "FirewallName": "cloudfirewall-manual",
  "FirewallServiceMode": "PrimaryStandby",
  "FirewallServiceZones": [
    "cn-hangzhou-i"
  ],
  "FirewallStatus": "Ready",
  "FirewallSubnetCidr": "10.0.1.0/24",
  "FirewallSwitchStatus": "opened",
  "FirewallVpcCidr": "10.0.0.0/16",
  "RegionNo": "cn-shanghai",
  "RequestId": "7E53A7FB-3EB9-5E33-8E50-B8F417D1E02B",
  "RouteMode": "managed",
  "TrAttachmentId": "tr-attach-r1llaxxeha71jsm36v",
  "TrAttachmentMasterCidr": "10.0.2.0/24",
  "TrAttachmentMasterZone": "cn-hangzhou-h",
  "TrAttachmentSlaveCidr": "10.0.3.0/24",
  "TrAttachmentSlaveZone": "cn-hangzhou-i",
  "TrAttachmentZones": [
    {
      "VSwitchCidr": "10.0.2.0/24",
      "VSwitchZoneId": "cn-hangzhou-h"
    }
  ],
  "TransitRouterId": "tr-wz9y8sgug8b1xb416****"
}

错误码

HTTP status code

错误码

错误信息

描述
400 ErrorTrFirewallNotExist Cen TR firewall not exist Cen TR firewall not exist
400 ErrorAliUid Aliuid invalid. aliuid无效
400 ErrorParameters Error Parameters 参数错误
400 ErrorDBTxError A database transaction error occurred. 内部错误：数据库事务错误
400 ErrorAuthentication authentication error 鉴权失败
400 ErrorDBSelectError A database select error occurred. 内部错误：数据库查询错误
400 ErrorDBNoRow No rows in database. 没有数据
400 ErrorMarshalJSON internal error. 内部错误。
400 ErrorUnMarshalJSON internal error. 内部错误
400 MissingParameter.FirewallId The required parameter 'FirewallId' is missing.

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

变更历史

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

上一篇：DescribeTrFirewallsV2List - 获取云企业网（企业版）防火墙列表下一篇：DescribeTrFirewallsV2RouteList - 获取TR防火墙路由表列表