DescribeTrFirewallV2RoutePolicyList - Cloud Firewall - Alibaba Cloud Documentation Center

Queries 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response message. Valid values: zh (default): Chinese en: English	zh
FirewallId	string	No	The ID of the VPC firewall instance.	vfw-tr-d5ba592ac6c84aff****
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
CurrentPage	integer	No	The page number. Default value: 1.	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>	A firewall routing policy.
PolicyType	string	The type of traffic redirection scenario for the VPC firewall. The firewall is created for a transit router that belongs to an Enterprise Edition Cloud Enterprise Network (CEN) instance. Valid values: fullmesh: full-mesh one_to_one: point-to-point end_to_end: point-to-multipoint	fullmesh
PolicyName	string	The name of the policy.	新加坡点到多点
PolicyDescription	string	The description of the policy.	点到多点
SrcCandidateList	array<object>	The list of source traffic redirection instances.
	object	The source 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 destination traffic redirection instances.
	object	The destination 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 status of the policy. Valid values: creating: The policy is being created. deleting: The policy is being deleted. opening: The policy is being enabled. opened: The policy is enabled. closing: The policy is being disabled. closed: The policy is disabled.	opened
RequestId	string	The request ID.	95EB5F3A-67FE-5780-92BD-5ECBA772AB7E
TotalCount	string	The total number of entries.	1

Examples

Success response

JSON format

{
  "TrFirewallRoutePolicies": [
    {
      "PolicyType": "fullmesh",
      "PolicyName": "新加坡点到多点",
      "PolicyDescription": "点到多点",
      "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.