You need to enable JavaScript to run this app.
Transit Router

Transit Router

Copy page
Download PDF
Forwarding policy
DescribeTransitRouterForwardPolicyTables - Querying the list of forwarding policies
Copy page
Download PDF
DescribeTransitRouterForwardPolicyTables - Querying the list of forwarding policies
Call the DescribeTransitRouterForwardPolicyTables API to query forwarding policies that meet the specified conditions.​
Debug​
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
​
Request parameters​
The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.​
Action String Example value: DescribeTransitRouterForwardPolicyTables​
The interface name. The current API is named DescribeTransitRouterForwardPolicyTables.​
​
Version String Example value: 2020-04-01​
The interface version. The current API version is 2020-04-01.​
​
PageSize Integer Optional Example value: 20​
The number of entries on each page in a pagination query. Valid values: 1–100. Default: 20.​
​
PageNumber Integer Optional Example value: 1​
Pagination page number.​
​
TransitRouterForwardPolicyTableIds.N String Optional Example value: tr-fpt-hy13n2l4c6c0v****​
ID of the forwarding policy.​
  • N represents the serial number of the forwarding policy, ranging from 1 to 100.​
  • Separate multiple forwarding policy IDs with ampersands (&).​
​
TransitRouterForwardPolicyTableName String Optional Example value: fpt-02​
The name of the forwarding policy.​
​
TransitRouterId String Example value: tr-1i5i8khf9m58gae5kcx6****​
The TR instance ID. You can call DescribeTransitRouters to obtain the TR instance ID.​
​
​
Response parameters​
The following only details response parameters specific to this API. For more information, see Response structure.​
PageNumber Integer Optional Example value: 1​
The current page number.​
​
PageSize Integer Optional Example value: 20​
Number of entries per page in the current pagination.​
​
TotalCount Integer Optional Example value: 2​
Total number of TR route tables that meet the conditions.​
​
TransitRouterForwardPolicyTables Object[] Optional Example value: --​
The details of qualified forwarding policies.​
CreationTime String Optional Example value: 2021-04-09T08:36:47+08:00​
The time when the forwarding policy is created.​
​
Status String Optional Example value: Available​
Status of the forwarding policy.​
  • Creating​
  • Deleting​
  • Pending: ​​Configuration in progress.​
  • Available​
​
TransitRouterForwardPolicyTableId String Optional Example value: tr-fpt-hy13n2l4c6c0v****​
ID of the forwarding policy.​
​
TransitRouterForwardPolicyTableName String Optional Example value: forwardpolicy-1​
The name of the forwarding policy.​
​
UpdateTime String Optional Example value: 2021-04-10T09:18:28+08:00​
The time when the forwarding policy is last updated.​
​
Description String Optional Example value: This route table is used for test.​
The description of the forwarding policy.​
​
​
​
Request examples​
​
GET /?Action=DescribeTransitRouterForwardPolicyTables&Version=2020-04-01&TransitRouterId=tr-1i5i8khf9m58gae5kcx6**** HTTP/1.1​
Host: transitrouter.cn-beijing.volcengineapi.com​
X-Date: 20250815T034225Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250815/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
Response examples​
​
{​
"ResponseMetadata": {​
"RequestId": "202508151142290301990370033D7C98",​
"Action": "DescribeTransitRouterForwardPolicyTables",​
"Version": "2020-04-01",​
"Service": "transitrouter",​
"Region": "cn-beijing"​
},​
"Result": {​
"PageNumber": 1,​
"PageSize": 20,​
"TotalCount": 2,​
"TransitRouterForwardPolicyTables": [​
{​
"CreationTime": "2021-04-09T08:36:47+08:00",​
"Status": "Available",​
"TransitRouterForwardPolicyTableId": "tr-fpt-hy13n2l4c6c0v****",​
"TransitRouterForwardPolicyTableName": "forwardpolicy-1",​
"UpdateTime": "2021-04-10T09:18:28+08:00",​
"Description": "This route table is used for test."​
}​
]​
}​
}​
​
Error codes​
The table below describes the error codes for this API that are associated with business logic. For more information, see Common error codes.​
​
Status code​
Error codes​
Error message​
Description​
400​
InvalidPage.Malformed​
The specified page is malformed.​
The specified pagination parameter is invalid.​
400​
LimitExceeded.ResourceIds​
You've reached the limit of 100 resource IDs that can be specified in this request.​
The request contains invalid or unsupported parameters. The maximum number of resource query results is 100.​
​
Last updated: 2026.01.09 16:26:47