调用ListTransitRouterRouteEntries接口查询企业版转发路由器路由表中的路由条目信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListTransitRouterRouteEntries

系统规定参数。取值:ListTransitRouterRouteEntries

MaxResults Integer 20

分批次查询时,每次显示的条目数。取值范围:1~100。默认值:20

TransitRouterRouteEntryDestinationCidrBlock String 192.168.0.0/24

路由条目的目标网段。

TransitRouterRouteEntryStatus String Active

路由条目的状态。取值:

  • Creating:添加中。
  • Active:可用。
  • Deleting:删除中。
TransitRouterRouteTableId String vtb-bp1dudbh2d5na6b50****

企业版转发路由器路由表ID。

NextToken String fce19****

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。
TransitRouterRouteEntryNames.N String testname

路由条目的名称。

名称长度为0~128个字符,可包含英文字母、数字、中文、半角逗号(,)、半角句号(.)、半角分号(;)、正斜线(/)、at(@)、下划线(_)和短划线(-)。

一次最多支持查询20条路由条目的信息。

说明 系统仅支持通过本参数查询静态配置的路由。
TransitRouterRouteEntryIds.N String rte-oklkgwmj97z6dn****

路由条目ID。

一次最多支持查询20条路由条目的信息。

说明 系统仅支持通过本参数查询静态配置的路由。

返回数据

名称 类型 示例值 描述
NextToken String fce19****

是否拥有下一次查询的令牌(Token)。取值:

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
RequestId String C3835E5E-1504-4344-B1BB-98A4110F1079

请求ID。

TotalCount Integer 6

总条目数。

MaxResults Integer 20

分批次查询时,每次显示的条目数。

TransitRouterRouteEntries Array of TransitRouterRouteEntry

路由条目信息列表。

TransitRouterRouteEntryId String rte-oklkgwmj97z6dn****

路由条目ID。

说明 只有静态配置的路由才会返回该参数值。
TransitRouterRouteEntryDestinationCidrBlock String 192.168.0.0/24

路由条目的目标网段。

TransitRouterRouteEntryType String Static

路由条目的类型。

  • Static:表示该路由条目为静态配置的路由。
  • Propagated:表示该路由条目为自动学习到的路由。
CreateTime String 2021-06-15T07:01Z

路由条目的创建时间。

时间按照ISO8601标准表示,并使用UTC时间。格式为:YYYY-MM-DDThh:mmZ。

说明 只有静态配置的路由才会返回该参数值。
TransitRouterRouteEntryName String testname

路由条目的名称。

说明 只有静态配置的路由才会返回该参数值。
TransitRouterRouteEntryStatus String Active

路由条目的状态。

  • Creating:添加中。
  • Active:可用。
  • Deleting:删除中。
TransitRouterRouteEntryNextHopType String BlackHole

路由条目的下一跳类型。

  • BlackHole:表示该路由条目为黑洞路由,所有去往目标网段的路由均会被丢弃。
  • Attachment:表示该路由条目的下一跳为网络实例连接,所有去往目标网段的路由均会被转发至指定的网络实例连接。
TransitRouterRouteEntryNextHopId String tr-attach-vx6iwhjr1x1j78****

路由条目的下一跳ID。

TransitRouterRouteEntryDescription String CidrRoute

路由条目的描述信息。

说明 只有静态配置的路由才会返回该参数值。
OperationalMode Boolean false

当前路由条目是否可操作。

  • true:可操作,表示您可以对当前路由条目执行删除操作。
  • false:不可操作,表示当前路由条目为系统自动生成,不支持编辑。
Tag String PermitVbr

路由条目的标签。

仅取值:PermitVbr,表示当前路由条目仅会被传播至转发路由器实例下VBR实例的路由表中。

说明 仅系统自动生成的转发路由器地址段的路由会返回当前参数。

示例

请求示例

http(s)://[Endpoint]/?Action=ListTransitRouterRouteEntries
&MaxResults=20
&TransitRouterRouteEntryDestinationCidrBlock=192.168.0.0/24
&TransitRouterRouteEntryStatus=Active
&TransitRouterRouteTableId=vtb-bp1dudbh2d5na6b50****
&NextToken=fce19****
&TransitRouterRouteEntryNames=["testname"]
&TransitRouterRouteEntryIds=["rte-oklkgwmj97z6dn****"]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTransitRouterRouteEntriesResponse>
    <NextToken>fce19****</NextToken>
    <RequestId>C3835E5E-1504-4344-B1BB-98A4110F1079</RequestId>
    <TotalCount>6</TotalCount>
    <MaxResults>20</MaxResults>
    <TransitRouterRouteEntries>
        <TransitRouterRouteEntryId>rte-oklkgwmj97z6dn****</TransitRouterRouteEntryId>
        <TransitRouterRouteEntryDestinationCidrBlock>192.168.0.0/24</TransitRouterRouteEntryDestinationCidrBlock>
        <TransitRouterRouteEntryType>Static</TransitRouterRouteEntryType>
        <CreateTime>2021-06-15T07:01Z</CreateTime>
        <TransitRouterRouteEntryName>testname</TransitRouterRouteEntryName>
        <TransitRouterRouteEntryStatus>Active</TransitRouterRouteEntryStatus>
        <TransitRouterRouteEntryNextHopType>BlackHole</TransitRouterRouteEntryNextHopType>
        <TransitRouterRouteEntryNextHopId>tr-attach-vx6iwhjr1x1j78****</TransitRouterRouteEntryNextHopId>
        <TransitRouterRouteEntryDescription>CidrRoute</TransitRouterRouteEntryDescription>
        <OperationalMode>false</OperationalMode>
        <Tag>PermitVbr</Tag>
    </TransitRouterRouteEntries>
</ListTransitRouterRouteEntriesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "fce19****",
  "RequestId" : "C3835E5E-1504-4344-B1BB-98A4110F1079",
  "TotalCount" : 6,
  "MaxResults" : 20,
  "TransitRouterRouteEntries" : [ {
    "TransitRouterRouteEntryId" : "rte-oklkgwmj97z6dn****",
    "TransitRouterRouteEntryDestinationCidrBlock" : "192.168.0.0/24",
    "TransitRouterRouteEntryType" : "Static",
    "CreateTime" : "2021-06-15T07:01Z",
    "TransitRouterRouteEntryName" : "testname",
    "TransitRouterRouteEntryStatus" : "Active",
    "TransitRouterRouteEntryNextHopType" : "BlackHole",
    "TransitRouterRouteEntryDescription" : "CidrRoute",
    "OperationalMode" : false,
    "Tag" : "PermitVbr"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidTransitRouterRouteTableId.NotFound TransitRouterRouteTableId is not found. 转发路由器路由表实例ID未找到。

访问错误中心查看更多错误码。