调用DescribeVpnGatewayRoutes按条件查询VPN网关的目的路由条目。

调试

API Explorer

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

去调试

请求参数

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

Action String 必选示例值：DescribeVpnGatewayRoutes

要执行的操作，取值：DescribeVpnGatewayRoutes。

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

API版本信息。

VpnGatewayId String 可选示例值：vgw-3tehy13n2l4c6c0v****

VPN网关实例的ID。您可调用DescribeVpnGateways查询VPN网关的ID信息。

VpnGatewayRouteIds.N String 可选示例值：vgr-1cwd2lwd4c8cnh****

VPN网关路由条目的ID。

参数 - N：表示路由条目ID的序号。

多个ID之间用&分隔。

PageSize Integer 可选示例值：20

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

PageNumber Integer 可选示例值：1

分页查询的页码。

如需传入此参数，请传入非负整数。

不传或传入0，则均默认为1。

NextHopId String 可选示例值：vgc-3tex2x1cwd4c6c0v****

路由下一跳IPsec连接的ID。您可调用DescribeVpnConnections查询IPsec连接的ID信息。

DestinationCidrBlock String 可选示例值：192.XX.XX.0/24

VPN网关路由条目的目标网段。

RouteType String 可选示例值：Static

路由类型。

Static：静态路由

BGP：BGP路由

Cloud：云上VPC路由

说明

暂不支持展示中转路由器（TR）同步的路由类型。

Status String 可选示例值：Available

VPN网关路由条目的状态。

Creating: 创建中

Deleting: 删除中

Pending：配置中

Available：生效的优选路由

Conflicted：未被优选、未生效的路由

说明

当路由的前缀一致时，路由优先级为Cloud类型 > Static路由 > BGP路由，因此会存在多条前缀一致的路由有些状态为Available，有些状态为Conflicted。

返回参数

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

RequestId String 可选示例值：20220322145233010225243081016A****

请求ID。

PageSize Integer 可选示例值：20

当前分页的行数。

PageNumber Integer 可选示例值：1

当前页码。

TotalCount Integer 可选示例值：33

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

VpnGatewayRoutes Object[] 可选示例值：-

路由条目的详细信息。

VpnGatewayRouteId String 可选示例值：vgr-3tex2c6c0v844c****

VPN网关路由条目的ID。

VpnGatewayId String 可选示例值：vgw-3tehy13n2l4c6c0v****

VPN网关实例的ID。

DestinationCidrBlock String 可选示例值：192.XX.XX.0/24

VPN网关路由条目的目的网段。

NextHopId String 可选示例值：vgc-3tex2x1cwd4c6c0v****

下一跳IPsec连接的ID。若RouteType为Cloud，此参数返回空字符串。

CreationTime String 可选示例值：2021-04-09T08:36:47+08:00

创建VPN网关路由条目的时间。

UpdateTime String 可选示例值：2021-04-09T09:30:40+08:00

修改VPN网关路由条目的时间

Status String 可选示例值：Available

VPN网关路由条目的状态。

Creating: 创建中

Deleting: 删除中

Pending：配置中

Available：生效的优选路由

Conflicted：未被优选、未生效的路由

说明

当路由的前缀一致时，路由优先级为Cloud类型 > Static路由 > BGP路由，因此会存在多条前缀一致的路由有些状态为Available，有些状态为Conflicted。

RouteType String 可选示例值：Static

路由类型。

Static：静态路由

BGP：BGP路由

Cloud：云上VPC路由

说明

暂不支持展示中转路由器（TR）同步的路由类型。

NextTunnelId String 可选示例值：tun-bp18h6dgapdbs1l7p****

下一跳的隧道ID。

仅双隧道模式的VPN网关返回该参数。

AsPath Object[] 可选示例值：-

BGP路由条目经过的 AS 路径信息。

Type String 可选示例值：Sequence

AS 路径的类型。

Sequence：正常顺序序列

Set：发生过聚合的顺序序列

Numbers Integer[] 可选示例值：[65533]

AS 路径序列。

如果AS 路径的类型Sequence，返回数据为最初的ASN序列信息，如[65533] 。

如果AS 路径的类型Set，则表明AS 路径发生过聚合，返回数据为聚合后的ASN序列信息，如[4,5] 。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	LimitExceeded.VpnGatewayRouteId	You've reached the limit on the number of VPN gateway route IDs that you can describe.	已达到可查询的VPN网关路由条目ID数量上限。

VPN连接