Use DescribeTrFirewallV2RoutePolicyList to query routing policies for a VPC firewall on a transit router - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Retrieves the list of routing policies for 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 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:DescribeTrFirewallV2RoutePolicyList

get

*All Resource

*

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) firewall. Note FirewallId is required. If this parameter is not specified, the ErrorParameters (400) error is returned. You can call DescribeTrFirewallsV2List to obtain the FirewallId. Prerequisites: CEN Enterprise Edition with a transit router and VPC mount are configured, and the FirewallId is obtained by calling DescribeTrFirewallsV2List.	vfw-tr-d5ba592ac6c84aff****
PageSize	integer	No	The maximum number of entries per page in a paged query. Default value: 10. For more information about paging, see the corresponding parameter descriptions.	10
CurrentPage	integer	No	The page number in a paged query. Default value: 1. For more information about paging, see the corresponding parameter descriptions.	1
PolicyId	string	No	The ID of the firewall routing policy.	policy-7b66257c14e141fb****

Response elements

Element	Type	Description	Example
	object
TrFirewallRoutePolicies	array<object>	The list of firewall routing policies.
	array<object>	The firewall routing policy.
PolicyType	string	The traffic redirection scenario type for the virtual private cloud (VPC) firewall on CEN Enterprise Edition. Valid values: fullmesh: multi-point interconnection one_to_one: point-to-point end_to_end: point-to-multipoint	fullmesh
PolicyName	string	The policy name.	Singapore Point to Multipoint
PolicyDescription	string	The policy description.	Point to multipoint
SrcCandidateList	array<object>	The list of primary traffic redirection instances.
	object	The primary traffic redirection instance.
CandidateId	string	The ID of the traffic redirection instance.	vpc-2ze9epancaw8t4sha****
CandidateType	string	The type of the traffic redirection instance.	VPC
DestCandidateList	array<object>	The list of secondary traffic redirection instances.
	object	The secondary traffic redirection instance.
CandidateId	string	The ID of the traffic redirection instance.	vpc-2ze9epancaw8t4sha****
CandidateType	string	The type of the traffic redirection instance.	VPC
TrFirewallRoutePolicyId	string	The ID of the firewall routing policy.	policy-7b66257c14e141fb****
PolicyStatus	string	The policy status. Valid values: creating: being created deleting: being deleted opening: being enabled opened: enabled closing: being disabled closed: disabled	opened
RequestId	string	The request ID.	95EB5F3A-67FE-5780-92BD-5ECBA772AB7E
TotalCount	string	The total number of entries returned.	1

Examples

Success response

JSON format

{
  "TrFirewallRoutePolicies": [
    {
      "PolicyType": "fullmesh",
      "PolicyName": "Singapore Point to Multipoint",
      "PolicyDescription": "Point to multipoint",
      "SrcCandidateList": [
        {
          "CandidateId": "vpc-2ze9epancaw8t4sha****",
          "CandidateType": "VPC"
        }
      ],
      "DestCandidateList": [
        {
          "CandidateId": "vpc-2ze9epancaw8t4sha****",
          "CandidateType": "VPC"
        }
      ],
      "TrFirewallRoutePolicyId": "policy-7b66257c14e141fb****",
      "PolicyStatus": "opened"
    }
  ],
  "RequestId": "95EB5F3A-67FE-5780-92BD-5ECBA772AB7E",
  "TotalCount": "1"
}

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	ErrorDBSelectError	A database select error occurred.	The error message returned because an internal error has occurred in querying the database.
400	ErrorTrFirewallNotExist	Cen TR firewall not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.