You need to enable JavaScript to run this app.
文档中心
中转路由器

中转路由器

复制全文
下载 pdf
路由条目
DescribeTransitRouterRouteEntries - 查询路由条目列表
复制全文
下载 pdf
DescribeTransitRouterRouteEntries - 查询路由条目列表
调用DescribeTransitRouterRouteEntries接口,查询满足指定条件的路由条目。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:DescribeTransitRouterRouteEntries​
接口名称。当前 API 的名称为DescribeTransitRouterRouteEntries。​
​
Version String 必选 示例值:2020-04-01​
接口版本。当前 API 的版本为2020-04-01。​
​
TransitRouterRouteEntryType String 可选 示例值:Static​
路由条目的类型。​
  • Static:静态路由。​
  • Propagated:自动学习路由。​
​
TransitRouterRouteEntryNextHopType String 可选 示例值:Attachment​
路由条目下一跳的类型。​
  • Attachment:网络实例,表示匹配该路由条目的流量会被转发到指定的网络实例。​
  • BlackHole:黑洞,表示匹配该路由条目的流量会被丢弃。​
​
TransitRouterRouteEntryNextHopResourceType String 可选 示例值:VPC​
路由条目下一跳网络实例的类型。​
  • VPC:私有网络。​
  • VPN:VPN连接。​
  • DirectConnectGateway:专线网关。​
  • TransitRouter:中转路由器。​
​
TransitRouterRouteTableId String 必选 示例值:tr-rtb-hy13n2l4c6c0v****​
中转路由器实例关联的路由表的ID。您可以调用DescribeTransitRouterRouteTables接口获取TR路由表的ID。​
​
DestinationCidrBlock String 可选 示例值:192.168.XX.XX/24​
路由条目的目标网段。​
​
PageNumber Integer 可选 示例值:1​
列表的页码,默认值为1。​
​
PageSize Integer 可选 示例值:20​
分页查询时每页的行数,取值范围为1 ~ 100,默认值为20。​
​
Status String 可选 示例值:Available​
路由条目的状态。​
  • Available:可用。​
  • Creating:创建中。​
  • Pending:配置中。​
  • Deleting:删除中。​
  • Conflicted:未生效。​
​
TransitRouterRouteEntryName String 可选 示例值:routeentry-01​
TR路由表路由条目的名称。​
​
TransitRouterRouteEntryIds.N String 可选 示例值:tr-rte-1i5i8khf9m58gae5kcx6****​
TR路由条目的ID。​
  • N:表示TR路由条目的序号,取值范围为1~100。​
  • 多个TR路由条目ID之间使用“&”分隔。​
​
TransitRouterRouteEntryNextHopId String 可选​
The ID of the route entry next hop.​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
PageSize Integer 示例值:20​
当前分页的行数。​
​
PageNumber Integer 示例值:1​
当前页码。​
​
TotalCount Integer 示例值:2​
符合条件的路由条目总数。​
​
TransitRouterRouteEntries Object[] 示例值:--​
符合条件的路由条目的详细信息。​
Description String 示例值:This is a sample description.​
路由条目的描述信息。​
​
DestinationCidrBlock String 示例值:192.168.XX.XX/24​
路由条目的目标网段。​
​
TransitRouterRouteEntryId String 示例值:tr-rte-12ghy8jkmg****​
路由条目的ID。​
​
TransitRouterRouteEntryName String 示例值:trentry01​
路由条目的名称。​
​
TransitRouterRouteEntryNextHopType String 示例值:Attachment​
路由条目的下一跳类型。​
  • Attachment:网络实例,表示匹配该路由条目的流量会被转发到指定的网络实例。​
  • BlackHole:黑洞,表示匹配该路由条目的流量会被丢弃。​
​
TransitRouterRouteEntryType String 示例值:Static​
路由条目的类型。​
  • Static:静态路由。​
  • Propagated:学习路由。​
​
AsPath String[] 示例值:20314​
路由条目的AS路径。​
​
CreationTime String 示例值:2021-04-09T08:36:47+08:00​
路由条目的创建时间。​
​
UpdateTime String 示例值:2021-04-09T08:36:47+08:00​
路由条目的的最近操作时间。​
​
Status String 示例值:Available​
路由条目的状态。​
  • Available:可用。​
  • Creating:创建中。​
  • Pending:配置中。​
  • Deleting:删除中。​
  • Conflicted:未生效。​
​
TransitRouterRouteEntryNextHopId String 示例值:tr-attach-vx6iwhjr1x****​
路由条目的下一跳ID。​
说明​
参数TransitRouterRouteEntryNextHopType为“Attachment”时,该参数生效。​
​
DestinationPrefixListId String 示例值:pl-1234567890abcdef0​
路由条目的目标前缀列表 ID,用于指定路由条目的目标地址范围。​
​
TransitRouterRouteEntryNextHopResourceId String 示例值:vpc-zyq1wxy1zy249​
路由条目的下一跳资源 ID,表示匹配该路由条目的流量会被转发到的目标资源 ID。​
​
TransitRouterRouteEntryNextHopVpnTunnelId String 示例值:tunnel-123456​
路由条目的下一跳 VPN 隧道 ID。​
路由条目下一跳为VPN连接,且该VPN连接为双隧道时返回该参数。​
​
TransitRouterRouteEntryNextHopResourceType String 示例值:VPC​
路由条目下一跳网络实例的类型。​
  • VPC:私有网络。​
  • VPN:VPN连接。​
  • DirectConnectGateway:专线网关。​
  • TransitRouter:中转路由器。​
​
​
​
​
请求示例​
​
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​
​
返回示例​
​
{​
"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****"​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidPage.Malformed​
The specified page is malformed.​
指定的分页参数不合法。​
​
​
最近更新时间:2026.03.24 10:26:55
这个页面对您有帮助吗?
有用
有用
无用
无用