All Products
Search

This Product

    Cloud Firewall:DescribeTrFirewallsV2Detail

    Document Center

    Cloud Firewall:DescribeTrFirewallsV2Detail

    Last Updated:Aug 01, 2025

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

    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 support 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

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Lang

    string

    No

    The language of the content within the response. Valid values:

    • zh (default): Chinese

    • en: English

    zh
    FirewallId

    string

    No

    The ID of the VPC firewall instance.

    vfw-tr-a5a6b89f46764928****

    Response parameters

    Parameter

    Type

    Description

    Example

    object

    FirewallName

    string

    The name of the VPC firewall instance.

    cloudfirewall-manual
    RequestId

    string

    The ID of the request.

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

    string

    The ID of the VPC firewall instance.

    vfw-tr-9c7c711abdfa4d80****
    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
    CenId

    string

    The ID of the CEN instance.

    cen-37nddhri7jf0d2****
    TransitRouterId

    string

    The ID of the transit router.

    tr-wz9y8sgug8b1xb416****
    RegionNo

    string

    The region ID of the transit router.

    cn-shanghai
    FirewallEniId

    string

    The ID of the ENI of the firewall.

    eni-uf621u00nafypeex****
    FirewallEniVpcId

    string

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

    vpc-2zeppcci782zeh2bk****
    FirewallEniVswitchId

    string

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

    vsw-uf6ptq1kl1c1d9pw9****
    FirewallDescription

    string

    The description of the firewall.

    VPC Firewall
    RouteMode

    string

    The routing mode. Valid values:

    • managed: automatic mode

    • manual: manual mode

    managed
    FirewallSwitchStatus

    string

    The status of the VPC firewall. Valid values:

    • opened: The firewall is enabled.

    • closed: The firewall is disabled.

    • notconfigured: The firewall is not configured.

    • configured: The firewall is configured.

    • creating: The firewall is being created.

    • opening: The firewall is being enabled.

    • deleting: The firewall is being deleted.

    Note

    If you do not specify this parameter, VPC firewalls in all states are queried.

    opened
    FirewallVpcCidr

    string

    The CIDR block of the VPC that is automatically created for the firewall in automatic mode.

    10.0.0.0/16
    FirewallSubnetCidr

    string

    The CIDR block of the vSwitch that is automatically created in the firewall VPC to host the ENI of the firewall in automatic mode.

    10.0.1.0/24
    TrAttachmentMasterCidr

    string

    The primary CIDR block of the vSwitch that is automatically created in the firewall VPC to connect to the transit router in automatic mode.

    10.0.2.0/24
    TrAttachmentSlaveZone

    string

    The secondary zone of the vSwitch that is automatically created in the firewall VPC to connect to the transit router in automatic mode.

    cn-hangzhou-i
    TrAttachmentSlaveCidr

    string

    The secondary CIDR block of the vSwitch that is automatically created in the firewall VPC to connect to the transit router in automatic mode.

    10.0.3.0/24
    TrAttachmentMasterZone

    string

    The primary zone of the vSwitch that is automatically created in the firewall VPC to connect to the transit router in automatic mode.

    cn-hangzhou-h

    Examples

    Success response

    JSON format

    {
  "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 Firewall",
  "RouteMode": "managed",
  "FirewallSwitchStatus": "opened",
  "FirewallVpcCidr": "10.0.0.0/16",
  "FirewallSubnetCidr": "10.0.1.0/24",
  "TrAttachmentMasterCidr": "10.0.2.0/24",
  "TrAttachmentSlaveZone": "cn-hangzhou-i",
  "TrAttachmentSlaveCidr": "10.0.3.0/24",
  "TrAttachmentMasterZone": "cn-hangzhou-h"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ErrorTrFirewallNotExist 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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.