All Products
Search
Document Center

Cloud Firewall:DescribeTrFirewallV2RoutePolicyList

Last Updated:Sep 02, 2024

Queries the routing policies of a virtual private cloud (VPC) firewall that is created for a transit router.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-cloudfirewall:DescribeTrFirewallV2RoutePolicyListget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

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

  • zh: Chinese (default)
  • en: English
zh
FirewallIdstringNo

The instance ID of the VPC firewall.

vfw-tr-d5ba592ac6c84aff****
PageSizeintegerNo

The number of entries per page. Default value: 10.

10
CurrentPageintegerNo

The page number. Default value: 1.

1
PolicyIdstringNo

The ID of the routing policy.

policy-7b66257c14e141fb****

Response parameters

ParameterTypeDescriptionExample
object
TrFirewallRoutePoliciesarray<object>

The routing policies.

object
PolicyTypestring

The type of the traffic redirection scenario of the VPC firewall. Valid values:

  • fullmesh: interconnected instances
  • one_to_one: instance to instance
  • end_to_end: instance to instances
fullmesh
PolicyNamestring

The name of the routing policy.

TEST_VPC_FW
PolicyDescriptionstring

The description of the routing policy.

test
SrcCandidateListarray<object>

The primary traffic redirection instances.

object
CandidateIdstring

The ID of the primary traffic redirection instance.

vpc-2ze9epancaw8t4sha****
CandidateTypestring

The type of the primary traffic redirection instance.

VPC
DestCandidateListarray<object>

The secondary traffic redirection instances.

object
CandidateIdstring

The ID of the secondary traffic redirection instance.

vpc-2ze9epancaw8t4sha****
CandidateTypestring

The type of the secondary traffic redirection instance.

VPC
TrFirewallRoutePolicyIdstring

The ID of the routing policy.

policy-7b66257c14e141fb****
PolicyStatusstring

The status of the routing 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
RequestIdstring

The request ID.

95EB5F3A-67FE-5780-92BD-5ECBA772AB7E
TotalCountstring

The total number of entries returned.

1

Examples

Sample success responses

JSONformat

{
  "TrFirewallRoutePolicies": [
    {
      "PolicyType": "fullmesh",
      "PolicyName": "TEST_VPC_FW",
      "PolicyDescription": "test",
      "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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-06-08The request parameters of the API has changed. The response structure of the API has changedView Change Details