You need to enable JavaScript to run this app.
导航
中转路由器
  • 文档首页
    • /
  • 中转路由器

DescribeTransitRouterRouteEntries

最近更新时间：2024.01.12 11:13:03

首次发布时间：2023.03.07 09:56:38

我的收藏

调用DescribeTransitRouterRouteEntries接口，查询满足指定条件的路由条目。

请求参数

名称类型是否必选示例值描述
ActionString是DescribeTransitRouterRouteEntries要执行的操作，取值为DescribeTransitRouterRouteEntries。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。
TransitRouterRouteTableIdString是tr-rtb-hy13n2l4c6c0v****中转路由器实例关联的路由表的ID。您可以调用DescribeTransitRouterRouteTables接口获取TR路由表的ID。
DestinationCidrBlockString否192.168.XX.XX/24路由条目的目标网段。
PageNumberInteger否1列表的页码，默认值为1。
PageSizeInteger否20分页查询时每页的行数，取值范围为1 ~ 100，默认值为20。

Status

String

否

Available

路由条目的状态。

  • Available：可用。
  • Creating：创建中。
  • Pending：配置中。
  • Deleting：删除中。
  • Conflicted：冲突。
TransitRouterRouteEntryNameString否路由条目的名称。

TransitRouterRouteEntryIds.N

String

否

TransitRouterRouteEntryIds.1=tr-rte-1i5i8khf9m58gae5kcx6****&TransitRouterRouteEntryIds.2=tr-rte-12ghy8jkmg****

TR路由条目的ID。您可以调用DescribeTransitRouterRouteEntries接口获取TR路由条目的ID。

  • 参数 - N：表示TR路由条目的序号，取值范围为1～100，单次最多可查询100个。
  • 多个TR路由条目ID之间使用“&”分隔。

返回参数

名称
类型
示例值
描述
RequestIdString0ED8D006-F706-4D23-88ED-E11ED28D****请求ID。
PageSizeInteger20当前分页的行数。
PageNumberInteger1当前页码。
TotalCountInteger2符合条件的路由条目总数。
TransitRouterRouteEntriesArray of Struct-符合条件的路由条目的详细信息。具体请参见下表“ TransitRouterRouteEntries ”。

TransitRouterRouteEntries

名称
类型
示例值
描述
DescriptionStringThis is a sample description.路由条目的描述信息。
DestinationCidrBlockString192.168.XX.XX/24路由条目的目标网段。

Status

String

Available

路由条目的状态。

  • Available：可用。
  • Creating：创建中。
  • Pending：配置中。
  • Deleting：删除中。
  • Conflicted：冲突。
TransitRouterRouteEntryIdStringtr-rte-12ghy8jkmg****路由条目的ID。
TransitRouterRouteEntryNameStringtrentry01路由条目的名称。

TransitRouterRouteEntryNextHopType

String

Attachment

路由条目的下一跳类型。

  • Attachment：网络实例，表示匹配该路由条目的流量会被转发到指定的网络实例。
  • BlackHole：黑洞，表示匹配该路由条目的流量会被丢弃。

TransitRouterRouteEntryNextHopId

String

tr-attach-vx6iwhjr1x****

路由条目的下一跳ID。

参数TransitRouterRouteEntryNextHopType为“Attachment”时，该参数生效。

TransitRouterRouteEntryType

String

Static

路由条目的类型。

  • Static：静态路由。
  • Propagated：学习路由。
AsPathList of String["20314","23141"]路由条目的AS路径。
CreationTimeString2021-04-09T08:36:47+08:00路由条目的创建时间。
UpdateTimeString2021-04-09T08:36:47+08:00路由条目的的最近操作时间。

请求示例

GET /?Action=DescribeTransitRouterRouteEntries&Version=2020-04-01&TransitRouterRouteTableId=tr-rtb-hy13n2l4c6c0v**** HTTP/1.1
Host: open.volcengineapi.com
Service: transitrouter
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeTransitRouterRouteEntries",
        "Version": "2020-04-01",
        "Service": "transitrouter",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "PageSize": 20,
        "PageNumber": 1,
        "TotalCount": 1,
        "TransitRouterRouteEntries": [
            {   
                "TransitRouterRouteEntryName": "trentry01",
                "TransitRouterRouteEntryId": "tr-rte-12ghy8jkmg****",
                "DestinationCidrBlock": "192.168.XX.XX/24",
                "Description": "This is a sample description.",
                "TransitRouterRouteEntryType": "Static",
                "TransitRouterRouteEntryNextHopType": "Attachment",
                "TransitRouterRouteEntryNextHopId": "vpc-bp1aevy8sofi8mh1****",
                "TransitRouterRouteTableId": "tr-rtb-hy13n2l4c6c0v****",
                "AsPath": [],
                "CreationTime": "2021-04-09T08:36:47+08:00",
                "UpdateTime": "2021-04-10T09:18:28+08:00",
                "Status": "Available"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode错误码错误信息描述
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。