All Products
Search

This Product

    Cloud Firewall:DescribeTrFirewallsV2Detail

    Document Center

    Cloud Firewall:DescribeTrFirewallsV2Detail

    Last Updated:Sep 21, 2026

    Retrieves the details of a VPC firewall for a transit router.

    Operation description

    Queries the details of a virtual private cloud (VPC) firewall for an Enterprise Edition transit router. You can call DescribeTrFirewallsV2List to obtain the FirewallId. If no firewall has been created, prepare an Enterprise Edition transit router in the Cloud Enterprise Network (CEN) console first, and then call CreateTrFirewallV2 to create a firewall and obtain the FirewallId.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    yundun-cloudfirewall:DescribeTrFirewallsV2Detail

    get

    *VpcCenTrFirewall

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Lang

    string

    No

    The language of the response. Valid values:

    • zh (default): Chinese

    • en: English

    zh
    FirewallId

    string

    No

    The ID of the VPC firewall instance. This parameter is required. If this parameter is not specified, the error ErrorMissingFirewallId (-360444, firewall id is required) is returned.

    Note

    You can call DescribeTrFirewallsV2List to query existing FirewallId values (in the format of vfw-tr-*). If no firewall has been created, create an Enterprise Edition transit router in the CEN console first, and then call CreateTrFirewallV2.

    vfw-tr-a5a6b89f46764928****

    Response elements

    Element

    Type

    Description

    Example

    object

    CenId

    string

    The instance ID of the Cloud Enterprise Network (CEN).

    cen-37nddhri7jf0d2****
    FirewallAttachmentZone

    string

    The zone ID used by the firewall connection.

    cn-hangzhou-h
    FirewallDescription

    string

    The description of the firewall.

    vpc-firewall-description
    FirewallEniId

    string

    The ID of the firewall ENI.

    eni-uf621u00nafypeex****
    FirewallEniVpcId

    string

    The ID of the VPC to which the firewall ENI belongs.

    vpc-2zeppcci782zeh2bk****
    FirewallEniVswitchId

    string

    The ID of the vSwitch to which the firewall ENI belongs.

    vsw-uf6ptq1kl1c1d9pw9****
    FirewallId

    string

    The instance ID of the virtual private cloud (VPC) firewalls.

    vfw-tr-9c7c711abdfa4d80****
    FirewallName

    string

    The instance name of the virtual private cloud (VPC) firewalls.

    cloudfirewall-manual
    FirewallServiceMode

    string

    The deployment mode of the VPC firewall for the transit router. Valid values: PrimaryStandby (active/standby mode) and MultiPrimary (active-active mode).

    PrimaryStandby
    FirewallServiceZones

    array

    The list of zone IDs used by the VPC firewall for the transit router.

    string

    The zone ID used by the VPC firewall for the transit router.

    cn-hangzhou-i
    FirewallStatus

    string

    The status of the firewall. Valid values:

    • Creating: The firewall is being created.

    • Deleting: The firewall is being deleted.

    • Ready: The firewall is ready.

    Ready
    FirewallSubnetCidr

    string

    The subnet CIDR block that stores the firewall ENI in the firewall VPC in automatic mode.

    10.0.1.0/24
    FirewallSwitchStatus

    string

    The status of the virtual private cloud (VPC) firewalls. Valid values:

    • opened: enabled.

    • closed: disabled.

    • notconfigured: the virtual private cloud (VPC) firewalls are not configured.

    • configured: the virtual private cloud (VPC) firewalls are configured but not enabled.

    • creating: the virtual private cloud (VPC) firewalls are being created.

    • opening: the virtual private cloud (VPC) firewalls are being enabled.

    • deleting: the virtual private cloud (VPC) firewalls are being deleted.

    Note

    If this parameter is not set, virtual private cloud (VPC) firewalls in all states are queried.

    opened
    FirewallVpcCidr

    string

    The CIDR block of the firewall VPC in automatic mode.

    10.0.0.0/16
    RegionNo

    string

    The region ID of the transit router instance.

    cn-shanghai
    RequestId

    string

    The request ID.

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

    string

    The routing mode. Valid values:

    • managed: automatic mode.

    • manual: manual mode.

    managed
    TrAttachmentId

    string

    The attachment ID used to connect the firewall VPC to the transit router in automatic mode.

    tr-attach-r1llaxxeha71jsm36v
    TrAttachmentMasterCidr deprecated

    string

    The primary subnet CIDR block used to connect the firewall VPC to the transit router in automatic mode.

    10.0.2.0/24
    TrAttachmentMasterZone deprecated

    string

    The primary zone used to connect the firewall VPC to the transit router in automatic mode.

    cn-hangzhou-h
    TrAttachmentSlaveCidr deprecated

    string

    The secondary subnet CIDR block used to connect the firewall VPC to the transit router in automatic mode.

    10.0.3.0/24
    TrAttachmentSlaveZone deprecated

    string

    The secondary zone used to connect the firewall VPC to the transit router in automatic mode.

    cn-hangzhou-i
    TrAttachmentZones

    array<object>

    The list of zones and vSwitch CIDR blocks for the transit router connection.

    object

    VSwitchCidr

    string

    The CIDR block of the vSwitch for the transit router connection.

    10.0.2.0/24
    VSwitchZoneId

    string

    The zone ID of the vSwitch for the transit router connection.

    cn-hangzhou-h
    TransitRouterId

    string

    The ID of the transit routing instance.

    tr-wz9y8sgug8b1xb416****

    Examples

    Success response

    JSON format

    {
  "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****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ErrorTrFirewallNotExist Cen TR firewall not exist Cen TR firewall not exist
    400 ErrorAliUid Aliuid invalid. The aliuid is invalid.
    400 ErrorParameters Error Parameters The parameter is invalid.
    400 ErrorDBTxError A database transaction error occurred. The error message returned because an internal error has occurred in the database transaction.
    400 ErrorAuthentication authentication error The authentication failed.
    400 ErrorDBSelectError A database select error occurred. The error message returned because an internal error has occurred in querying the database.
    400 ErrorDBNoRow No rows in database. No data found.
    400 ErrorMarshalJSON internal error. Internal error.
    400 ErrorUnMarshalJSON internal error. Internal Error
    400 MissingParameter.FirewallId The required parameter 'FirewallId' is missing.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.