Transit Router
Transit Router
Document
- Documentation
Transit RouterAPI referenceRoute entryDescribeTransitRouterRouteEntries - Querying the list of route entries
Copy page
Download PDFRoute entry
DescribeTransitRouterRouteEntries - Querying the list of route entries
Copy pageDownload PDFDescribeTransitRouterRouteEntries - Querying the list of route entries
Call DescribeTransitRouterRouteEntries to query route entries that meet 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 required Example: DescribeTransitRouterRouteEntries
The interface name. The current API name is DescribeTransitRouterRouteEntries.
Version String required Example: 2020-04-01
The interface version. The current API version is 2020-04-01.
TransitRouterRouteEntryType String optional Example: Static
The route type.
- Static: Static route
- Propagated: Auto-learned route.
TransitRouterRouteEntryNextHopType String optional Example: Attachment
The next hop type of the route.
- Attachment: A network instance, indicating that traffic matching the route is forwarded to the specified network instance.
- BlackHole: A blackhole, indicating that traffic matching the route is discarded.
TransitRouterRouteEntryNextHopResourceType String optional Example: VPC
The network instance type of the route's next hop.
- VPC: Virtual Private Cloud.
- VPN: Virtual Private Network.
- DirectConnectGateway: Direct Connect Gateway.
- TransitRouter: Transit Router.
TransitRouterRouteTableId String required Example: tr-rtb-hy13n2l4c6c0v****
The ID of the route table associated with the TR instance. You can call the DescribeTransitRouterRouteTables API to obtain the TR route table ID.
DestinationCidrBlock String optional Example: 192.168.XX.XX/24
The destination CIDR block of the route.
PageNumber Integer optional Example: 1
The page number of the list. Default: 1.
PageSize Integer optional Example: 20
The number of entries on each page in a pagination query. Valid values: 1–100. Default: 20.
Status String optional Example: Available
The route status.
- Available
- Creating
- Pending: Configuration in progress.
- Deleting
- Conflicted: Not effective.
TransitRouterRouteEntryName String optional Example: routeentry-01
The name of the route in the TR route table.
TransitRouterRouteEntryIds.N String optional Example: tr-rte-1i5i8khf9m58gae5kcx6****
The ID of the TR route.
- N represents the sequence number of a TR route, with a valid range of 1 to 100.
- Separate multiple TR route IDs with ampersands (&).
TransitRouterRouteEntryNextHopId String optional
The ID of the route entry next hop.
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 rows on the current page.
PageNumber Integer Example: 1
Current page number.
TotalCount Integer Example: 2
Total number of qualified route entries.
TransitRouterRouteEntries Object[] Example: --
The details of qualified route entries.
Description String Example: This is a sample description.
Description of the route.
DestinationCidrBlock String Example: 192.168.XX.XX/24
The destination CIDR block of the route.
TransitRouterRouteEntryId String Example: tr-rte-12ghy8jkmg****
The route ID.
TransitRouterRouteEntryName String Example: trentry01
The route name.
TransitRouterRouteEntryNextHopType String Example: Attachment
The next hop type of the route.
- Attachment: A network instance, indicating that traffic matching the route is forwarded to the specified network instance.
- BlackHole: A blackhole, indicating that traffic matching the route is discarded.
TransitRouterRouteEntryType String Example: Static
The route type.
- Static: Static route
- Propagated: Learned route.
AsPath String[] Example: 20314
The AS path of the route.
CreationTime String Example: 2021-04-09T08:36:47+08:00
The time when the route is created.
UpdateTime String Example: 2021-04-09T08:36:47+08:00
The time when the route is last modified.
Status String Example: Available
The route status.
- Available
- Creating
- Pending: Configuration in progress.
- Deleting
- Conflicted: Not effective.
TransitRouterRouteEntryNextHopId String Example: tr-attach-vx6iwhjr1x****
The next hop ID of the route.
tip
This parameter takes effect when TransitRouterRouteEntryNextHopType is set to “Attachment”.
DestinationPrefixListId String Example: pl-1234567890abcdef0
The ID of the target prefix list for the route entry. It specifies the destination address range of the route entry.
TransitRouterRouteEntryNextHopResourceId String Example: vpc-zyq1wxy1zy249
The next-hop resource ID of the route entry. It indicates the ID of the target resource to which traffic matching this route entry will be forwarded.
TransitRouterRouteEntryNextHopVpnTunnelId String Example: tunnel-123456
The tunnel ID of the VPN which is the Next Hop of the route entry.
This parameter is returned when the Next Hop of the route entry is a VPN attachment with dual tunnels.
TransitRouterRouteEntryNextHopResourceType String Example: VPC
The network instance type of the route's next hop.
- VPC: Virtual Private Cloud.
- VPN: Virtual Private Network.
- DirectConnectGateway: Direct Connect Gateway.
- TransitRouter: Transit Router.
Request examples
GET /?Action=DescribeTransitRouterRouteEntries&Version=2020-04-01&TransitRouterRouteTableId=tr-rtb-hy13n2l4c6c0v**** HTTP/1.1
Host: transitrouter.cn-beijing.volcengineapi.com
X-Date: 20250804T093131Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250804/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
Response examples
{
"ResponseMetadata": {
"RequestId": "20250804173134071211148112D3F0A8",
"Action": "DescribeTransitRouterRouteEntries",
"Version": "2020-04-01",
"Service": "transitrouter",
"Region": "cn-beijing"
},
"Result": {
"TransitRouterRouteEntryNextHopResourceType": "VPC",
"TransitRouterRouteEntryNextHopResourceID": "vpc-az1289azgaqsa125",
"PageSize": 20,
"PageNumber": 1,
"TotalCount": 2,
"TransitRouterRouteEntries": [
{
"Description": "This is a sample description.",
"DestinationCidrBlock": "192.168.XX.XX/24",
"TransitRouterRouteEntryId": "tr-rte-12ghy8jkmg****",
"TransitRouterRouteEntryName": "trentry01",
"TransitRouterRouteEntryNextHopType": "Attachment",
"TransitRouterRouteEntryType": "Static",
"AsPath": [
"20314"
],
"CreationTime": "2021-04-09T08:36:47+08:00",
"UpdateTime": "2021-04-09T08:36:47+08:00",
"Status": "Available",
"TransitRouterRouteEntryNextHopId": "tr-attach-vx6iwhjr1x****"
}
]
}
}
Error codes
The following table lists the error codes related to the business logic for this API. For details, see Common error codes.
Status code | Error codes | Description | |
400 | InvalidPage.Malformed | The specified pagination parameter is invalid. |
Last updated: 2026.03.25 16:30:47
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
