You need to enable JavaScript to run this app.
导航
VPN连接
  • 文档首页
    • /
  • VPN连接

DescribeVpnGatewayRoutes

最近更新时间：2024.04.18 17:23:57

首次发布时间：2022.04.28 07:17:15

我的收藏

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

调试

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

请求参数

名称类型是否必选示例值描述
ActionString是DescribeVpnGatewayRoutes要执行的操作，取值：DescribeVpnGatewayRoutes。
VersionString是2020-04-01API版本信息。
VpnGatewayIdString否vgw-3tehy13n2l4c6c0v****VPN网关实例的ID。您可调用DescribeVpnGateways查询VPN网关的ID信息。

VpnGatewayRouteIds.N

String

否

VpnGatewayRouteIds.1=vgr-1cwd2lwd4c8cnh****&VpnGatewayRouteIds.2=vgr-0cdnksc8ewl3cds****

VPN网关路由条目的ID。

  • 参数 - N：表示路由条目ID的序号。
  • 多个ID之间用&分隔。
PageSizeInteger否20分页查询时每页的行数。最大值：100，默认值：20。

PageNumber

Integer

否

1

分页查询的页码。

  • 如需传入此参数，请传入非负整数。
  • 不传或传入0，则均默认为1。
NextHopIdString否vgc-3tex2x1cwd4c6c0v****路由下一跳IPsec连接的ID。您可调用DescribeVpnConnections查询IPsec连接的ID信息。
DestinationCidrBlockString否192.XX.XX.0/24VPN网关路由条目的目标网段。

返回数据

名称类型
示例值
描述
RequestIdString20220322145233010225243081016A****请求ID。
PageSizeInteger20当前分页的行数。
PageNumberInteger1当前页码。
TotalCountInteger33符合条件的路由条目总数。
VpnGatewayRoutesArray of struct-路由条目的详细信息，具体请参见下表“VpnGatewayRoute”。

VpnGatewayRoute

名称类型
示例值
描述
VpnGatewayRouteIdStringvgr-3tex2c6c0v844c****VPN网关路由条目的ID。
VpnGatewayIdStringvgw-3tehy13n2l4c6c0v****VPN网关实例的ID。
DestinationCidrBlockString192.XX.XX.0/24VPN网关路由条目的目的网段。
NextHopIdStringvgc-3tex2x1cwd4c6c0v****下一跳IPsec连接的ID。
CreationTimeString2021-04-09T08:36:47+08:00创建VPN网关路由条目的时间。
UpdateTimeString2021-04-09T09:30:40+08:00修改VPN网关路由条目的时间

Status

String

Available

VPN网关路由条目的状态。

  • Creating: 创建中
  • Deleting: 删除中
  • Pending：配置中
  • Available：可用

请求示例

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",
                "Status": "Available"
            }
        ]
    }
}

错误码

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

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