All Products
Search
Document Center

Cloud Firewall:DescribeTrFirewallsV2RouteList

Last Updated:Jul 20, 2026

Retrieves the route table list of a VPC firewall for a transit router. Prerequisites: CEN → Enterprise Edition transit router → VPC connection → CreateTrFirewallV2 → routing policy.

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:DescribeTrFirewallsV2RouteList

get

*All Resource

*

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 instance ID of the virtual private cloud (VPC) firewalls.

Note

FirewallId is required. If it is not specified, ErrorParameters(400) is returned. TrFirewallRoutePolicyId must be used together with FirewallId. If TrFirewallRoutePolicyId is specified without FirewallId, ErrorParameters(400) is returned. If the value is invalid or does not exist, ErrorTrFirewallPolicyNotFound is returned.

vfw-tr-8bcfa0f2f12d411e****

TrFirewallRoutePolicyId

string

No

The ID of the firewall routing policy.

policy-7d5c672e37ee4175****

CurrentPage

string

No

The page number in a paging query. Default value: 1.

1

PageSize

string

No

The maximum number of entries per page in a paging query. Default value: 10.

10

Response elements

Element

Type

Description

Example

object

FirewallRouteDetailList

array<object>

The route table list of Cloud Firewall.

object

The route table of Cloud Firewall.

TrFirewallRoutePolicyId

string

The ID of the firewall routing policy.

policy-04ecbbc6720d4f90****

TrFirewallRouteTableId

string

The ID of the route table to which the route belongs.

vtb-2zeockxxxorv0mnhz****

TrFirewallRouteDestination

string

The destination address of the route.

192.168.10.0/25

TrFirewallRouteNexthop

string

The next hop ID of the route.

tr-attach-hnxab1y0pxn16p****

RequestId

string

The request ID.

ABF190A2-B4D0-53F6-995A-5690A721F91C

Examples

Success response

JSON format

{
  "FirewallRouteDetailList": [
    {
      "TrFirewallRoutePolicyId": "policy-04ecbbc6720d4f90****",
      "TrFirewallRouteTableId": "vtb-2zeockxxxorv0mnhz****",
      "TrFirewallRouteDestination": "192.168.10.0/25",
      "TrFirewallRouteNexthop": "tr-attach-hnxab1y0pxn16p****"
    }
  ],
  "RequestId": "ABF190A2-B4D0-53F6-995A-5690A721F91C"
}

Error codes

HTTP status code

Error code

Error message

Description

400 ErrorAliUid Aliuid invalid. The aliuid is invalid.
400 ErrorParameters Error Parameters The parameter is invalid.
400 ErrorAuthentication authentication error The authentication failed.
400 ErrorDBTxError A database transaction error occurred. The error message returned because an internal error has occurred in the database transaction.
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 ErrorTrFirewallPolicyNotFound TR firewall policy does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.