文档

DescribeTrFirewallsV2Detail - 获取TR防火墙详情

更新时间:

获取TR防火墙详情。

调试

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

授权信息

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

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

请求参数

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

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

  • zh(默认):中文
  • en:英文
zh
FirewallIdstring

VPC 边界防火墙实例 ID。

vfw-tr-a5a6b89f46764928****

返回参数

名称类型描述示例值
object
FirewallNamestring

VPC 边界防火墙实例名称。

cloudfirewall-manual
RequestIdstring

返回结果的请求 ID。

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

VPC 边界防火墙实例 ID。

vfw-tr-9c7c711abdfa4d80****
FirewallStatusstring

防火墙状态。取值:

  • Creating:创建中

  • Deleting:删除中

  • Ready:就绪

Ready
CenIdstring

云企业网实例 ID。

cen-37nddhri7jf0d2****
TransitRouterIdstring

转发路由器实例 ID。

tr-wz9y8sgug8b1xb416****
RegionNostring

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

cn-shanghai
FirewallEniIdstring

防火墙 ENI ID。

eni-uf621u00nafypeex****
FirewallEniVpcIdstring

防火墙 ENI 所在的 VPC ID。

vpc-2zeppcci782zeh2bk****
FirewallEniVswitchIdstring

防火墙 ENI 所在的 VSWITCH ID。

vsw-uf6ptq1kl1c1d9pw9****
FirewallDescriptionstring

防火墙描述。

VPC边界防火墙
RouteModestring

路由模式。取值:

  • managed:表示自动模式

  • manual:表示手动模式

managed
FirewallSwitchStatusstring

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

  • opened:已开启

  • closed:已关闭

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

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

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

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

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

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

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

10.0.0.0/16
FirewallSubnetCidrstring

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

10.0.1.0/24
TrAttachmentMasterCidrstring

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

10.0.2.0/24
TrAttachmentSlaveCidrstring

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

10.0.3.0/24

示例

正常返回示例

JSON格式

{
  "FirewallName": "cloudfirewall-manual",
  "RequestId": "7E53A7FB-3EB9-5E33-8E50-B8F417D1E02B",
  "FirewallId": "vfw-tr-9c7c711abdfa4d80****",
  "FirewallStatus": "Ready",
  "CenId": "cen-37nddhri7jf0d2****",
  "TransitRouterId": "tr-wz9y8sgug8b1xb416****",
  "RegionNo": "cn-shanghai",
  "FirewallEniId": "eni-uf621u00nafypeex****",
  "FirewallEniVpcId": "vpc-2zeppcci782zeh2bk****",
  "FirewallEniVswitchId": "vsw-uf6ptq1kl1c1d9pw9****",
  "FirewallDescription": "VPC边界防火墙",
  "RouteMode": "managed",
  "FirewallSwitchStatus": "opened",
  "FirewallVpcCidr": "10.0.0.0/16",
  "FirewallSubnetCidr": "10.0.1.0/24",
  "TrAttachmentMasterCidr": "10.0.2.0/24",
  "TrAttachmentSlaveCidr": "10.0.3.0/24"
}

错误码

HTTP status code错误码错误信息描述
400ErrorTrFirewallNotExistCen TR firewall not exist云企业网企业版防火墙不存在

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

变更历史

变更时间变更内容概要操作
2023-07-20OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
2023-07-19OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈