Transit Router
Transit Router
Document
- Documentation
Transit RouterAPI referenceRoute tablesDescribeTransitRouterRouteTables - Listing TR route tables
Copy page
Download PDFRoute tables
DescribeTransitRouterRouteTables - Listing TR route tables
Copy pageDownload PDFDescribeTransitRouterRouteTables - Listing TR route tables
Call the DescribeTransitRouterRouteTables API to query basic information (such as name, creation time, and route table type) for Transit Router (TR) route tables that meet the specified filter conditions.
Precautions
To query route details, such as destination CIDR block and Next Hop, call the DescribeTransitRouterRouteEntries API.
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 required Example: DescribeTransitRouterRouteTables
The interface name. The current API name is DescribeTransitRouterRouteTables.
Version String required Example: 2020-04-01
The interface version. The current API version is 2020-04-01.
TransitRouterId String required Example: tr-7qthudw0ll6jmc****
The ID of the TR instance. You can call the DescribeTransitRouters API to obtain the TR instance ID.
PageNumber Integer optional Example: 1
The page number of the list. Default: 1.
PageSize Integer optional Example: 20
The number of entries per page in a pagination query. Valid range: 1–100. Default: 20.
TransitRouterRouteTableIds.N String optional Example: tr-rtb-hy13n2l4c6c0v****
The ID of the TR route table.
- N represents the sequence number of a TR route table, ranging from 1 to 100.
- Separate multiple TR route table IDs with ampersands (&).
TransitRouterRouteTableType String optional Example: System
The type of the TR route table.
- System: System route table.
- Custom: Custom route table.
TagFilters.N.Key String optional Example: k1
The tag key of the TR route table.
- N represents the sequence number of a tag key, ranging from 1 to 10.
- Separate multiple tag keys with ampersands (&).
- Specifying multiple tag keys means querying the TR route tables that contain all specified tag keys.
TagFilters.N.Values.N String optional Example: v1
The tag value of the TR route table.
- The first N represents the sequence number of a tag key, ranging from 1 to 10.
- The second N represents the sequence number of a tag value, ranging from 1 to 3. The relationship between multiple tag values for the same tag key is a logical "OR". That is, the query returns resources tagged with any one of the specified values for that key.
- Separate multiple tags with ampersands (&).
- To provide this parameter, you must first provide TagFilters.N.Key.
- When this parameter is set to an empty string, it means querying resources where the tag value is empty for the specified tag key.
Response parameters
Only the response parameters specific to this API are listed below. For more information, see Response structure.
PageSize Integer Example: 20
The number of entries per page in the current pagination.
PageNumber Integer Example: 1
The current page number.
TotalCount Integer Example: 2
Total number of TR route tables that meet the conditions.
TransitRouterRouteTables Object[] Example: --
The details of TR route tables that meet the conditions.
CreationTime String Example: 2021-04-09T08:36:47+08:00
The time when the TR route table is created.
Description String Example: This route table is used for test.
The description of the TR route table.
Status String Example: Available
The status of the TR route table.
- Creating
- Deleting
- Pending: Configuration in progress.
- Available
TransitRouterRouteTableId String Example: tr-rtb-im8p5z1v7rb48g****
The ID of the TR route table.
TransitRouterRouteTableName String Example: route-1
The name of the TR route table.
TransitRouterRouteTableType String Example: System
The type of the TR route table.
InRoutePolicyTableId String Example: tr-rtp-im8p5z1v7rb48g****
The ID of the inbound route policy associated with the TR route table.
OutRoutePolicyTableId String Example: tr-rtp-hy13n2v7r3g4****
The ID of the outbound route policy associated with the TR route table.
UpdateTime String Example: 2021-04-10T09:18:28+08:00
The time when the TR route table is last modified.
Tags Object[] Example: --
The tag information of the TR route table.
Key String Example: k1
The tag key.
Value String Example: v1
The tag value.
Request example
GET /?Action=DescribeTransitRouterRouteTables&Version=2020-04-01&TransitRouterId=tr-7qthudw0ll6jmc**** HTTP/1.1
Host: transitrouter.cn-beijing.volcengineapi.com
X-Date: 20250804T035321Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250804/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
Response example
{
"ResponseMetadata": {
"RequestId": "202508041153251881211922103DB215",
"Action": "DescribeTransitRouterRouteTables",
"Version": "2020-04-01",
"Service": "transitrouter",
"Region": "cn-beijing"
},
"Result": {
"PageSize": 20,
"PageNumber": 1,
"TotalCount": 2,
"TransitRouterRouteTables": [
{
"CreationTime": "2021-04-09T08:36:47+08:00",
"Description": "This route table is used for test.",
"Status": "Available",
"TransitRouterRouteTableId": "tr-rtb-im8p5z1v7rb48g****",
"TransitRouterRouteTableName": "route-1",
"TransitRouterRouteTableType": "System",
"InRoutePolicyTableId": "tr-rtp-im8p5z1v7rb48g****",
"OutRoutePolicyTableId": "tr-rtp-hy13n2v7r3g4****",
"UpdateTime": "2021-04-10T09:18:28+08:00",
"Tags": [
{
"Key": "k1",
"Value": "v1"
}
]
}
]
}
}
Error codes
The following table lists the error codes related to the business logic for this API. For details, see Common error codes.
Last updated: 2026.06.24 16:08:49
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
