DescribeVpnGatewayRoutes--VPN连接-火山引擎

文档中心

立即注册

导航

DescribeVpnGatewayRoutes

最近更新时间：2024.09.25 15:57:09首次发布时间：2022.04.28 07:17:15

调用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	否	VpnGatewayRouteIds.1=vgr-1cwd2lwd4c8cnh**&VpnGatewayRouteIds.2=vgr-0cdnksc8ewl3cds**	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	Array of struct	-	路由条目的详细信息，具体请参见下表“VpnGatewayRoute”。

VpnGatewayRoute

名称	类型	示例值	描述
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）同步的路由类型。
AsPath	Array of AsSegment	-	BGP路由条目经过的 AS 路径信息，具体请参见下表“AsSegment”。

AsSegment

名称类型 示例值 描述

名称	类型	示例值	描述
Type	String	Sequence	AS 路径的类型。 Sequence：正常顺序序列 Set：发生过聚合的顺序序列
Numbers	Integer	[65533]	AS 路径序列。如果AS 路径的类型`Sequence`，返回数据为最初的ASN序列信息，如[65533] ；如果AS 路径的类型`Set`，则表明AS 路径发生过聚合，返回数据为聚合后的ASN序列信息，如[4,5] 。

Type

String

Sequence

AS 路径的类型。

Sequence：正常顺序序列
Set：发生过聚合的顺序序列

Numbers

Integer

[65533]

AS 路径序列。

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

请求示例

GET /?Action=DescribeVpnGatewayRoutes&Version=2020-04-01&VpnGatewayRouteIds.1=vgr-3tex2c6c0v844c**** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220322145233010225243081016A****",
        "Action": "DescribeVpnGatewayRoutes",
        "Version": "2020-04-01",
        "Service": "vpn",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20220322145233010225243081016A****",
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "VpnGatewayRoutes": [
            {
                "VpnGatewayId":"vgw-3tehy13n2l4c6c0v****",
                "VpnGatewayRouteId": "vgr-3tex2c6c0v844c****",
                "DestinationCidrBlock":"172.XX.XX.0/24",
                "NextHopId":"vgc-3tex2x1cwd4c6c0v****",
                "CreationTime": "2022-03-16T17:05:42+08:00",
                "UpdateTime": "2021-04-09T09:30:40+08:00",
                "RouteType":"BGP",
				        "AsPath":[
				          {
				            "Type":"Sequence",
				            "Numbers":[
				                65533
				             ]
				           }
				         ],
                "Status": "Available"
            }
        ]
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
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数量上限。