调用 DescribeRouteEntryList 接口，在指定路由表内查询满足指定条件的路由条目。

使用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的路由条目，若没有符合条件的路由条目，则返回空值。

若请求参数非必选参数均未传入，则返回指定路由表的所有路由条目。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action String 必选示例值：DescribeRouteEntryList

接口名称。当前 API 的名称为DescribeRouteEntryList。

Version String 必选示例值：2020-04-01

接口版本。当前 API 的版本为 2020-04-01。

RouteTableId String 必选示例值：vtb-2fdzao4h726f45oxruw****

待查询路由表的ID。

您可以调用 DescribeRouteTableList 接口，查询路由表的ID。

RouteEntryType String 可选示例值：Custom

路由条目的类型，固定传入Custom。

说明

传入任意非必填参数时，必须传入本参数。

RouteEntryId String 可选示例值：rte-3tj9gw2pwq3vj0****

路由条目的ID。

RouteEntryName String 可选示例值：Test route entry

路由条目的名称。

NextHopType String 可选示例值：NetworkInterface

子网路由表：路由条目的下一跳的类型。取值如下：

Instance：ECS实例。

HaVip：高可用虚拟IP。

NetworkInterface：辅助网卡。

NatGW：NAT网关。

VpcPeer：云企业网（同地域）。

RegionGW：云企业网（跨地域）。

TransitRouter：中转路由器。

IPv6GW：IPv6网关。

CloudConnector：云连接器。

GWLBEndpoint：网关负载均衡终端节点。

InstanceGroup：服务器组。

网关路由表：路由条目的下一跳的类型。取值如下：

NetworkInterface：辅助网卡

GWLBEndpoint：网关负载均衡终端节点。

说明

网关负载均衡、IPv6网关、云连接器、服务器组、网关路由表正在邀测中，如需试用，请联系客户经理。

NextHopId String 可选示例值：eni-2fdzbqxfwrt345oxruv******

路由条目的下一跳资源ID。

请根据下一跳类型，传入正确的资源ID。

DestinationCidrBlock String 可选示例值：8.XX.XX.1/22

路由条目的目标网段。

DestinationPrefixListId String 可选示例值：route-prefixlist-1

前缀列表的ID。

PageNumber Integer 可选示例值：1

列表的页码。默认值为1。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

PageSize Integer 可选示例值：20

分页查询时每页的行数。最大值为100，默认值为20。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

NextToken String 可选示例值：caeba0bbb2be03f84eb48b699f0a****

分页查询凭证，用于标记分页的位置。

不填则从头开始查询。

传入之前调用本API返回的NextToken，则从该次API调用标记分页的位置往后开始查询。

MaxResults Integer 可选示例值：50

查询的数量，默认为 10，最大为100。

VpcId String 可选示例值：vpc-2fdz8g5nruzuo5oxru****

路由表所属VPC的ID。

您可以调用 DescribeVpcs接口，查询VPC的ID。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

RequestId String 示例值：2021062415303301022514515207C4****

请求ID。

TotalCount Integer 示例值：2

符合条件的路由条目总数。

说明

本参数即将下线，使用NextToken和MaxResults分页查询时，此参数无意义。

PageNumber Integer 示例值：1

当前页码。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

PageSize Integer 示例值：10

当前分页的行数。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

NextToken String 示例值：caeba0bbb2be03f84eb48b699f0a****

本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。

RouteEntries Object[] 示例值：-

路由条目的详细信息。

Description String 示例值：This is the first route

路由条目描述。

DestinationCidrBlock String 示例值：8.XX.XX.0/16

路由条目的目标网段。

RouteEntryId String 示例值：rte-3tj9gw2pwq3vj******

路由条目ID。

RouteEntryName String 示例值：test-route

路由条目名称。

RouteTableId String 示例值：vtb-fadfgegg******

路由条目所属路由表的ID。

Status String 示例值：Available

路由规则状态。

Pending：配置中

Available：可用

Type String 示例值：Custom

路由条目类型。

Custom：自定义路由条目

System：系统路由条目

VpcId String 示例值：vpc-3tj9fo0uqy3vj0******

路由条目所属私有网络的ID。

NextHopId String 示例值：eni-2fdzbqxfwrt345oxru******

下一跳资源的ID。

NextHopType String 示例值：NetworkInterface

下一跳类型。

PrefixListCidrBlocks String[] 示例值：["8.XX.XX.0/16"]

前缀列表的CIDR。

NextHopName String 示例值：eni-test

下一跳资源的名称。

请求示例

返回示例

错误码

状态码	错误码	错误信息	说明
400	DryRunOperation	Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.	该请求设置为DryRun操作，操作授权已获得许可，但未被实际执行。
400	InvalidCidr.Malformed	The specified cidr block is malformed.	指定的网段格式不合法。
400	InvalidMaxResults.Malformed	The specified parameter MaxResults is malformed.	查询数量不合法。
400	InvalidNextToken.Malformed	The specified parameter NextToken is invalid.	查询 NextToken 不合法。
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	LimitExceeded.RouteEntryIds	You've reached the limit on the number of route entry ids that you can describe.	已达到可查询的路由条目ID数量上限。
403	Forbidden	You are not authorized to create IPv6 only subnet.	无权限创建IPv6 only的子网。
404	InvalidRouteNextHop.NotFound	The specified next hop does not exist.	指定的下一跳不存在。
404	InvalidRouteTable.NotFound	The specified route table does not exist.	指定的路由表不存在。