Use DescribeVcoRouteEntries to query IPsec-VPN connection routes - VPN Gateway - Alibaba Cloud - VPN Gateway

Queries information about routes under an IPsec-VPN connection by calling the DescribeVcoRouteEntries operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeVcoRouteEntries

list

*VpnConnections

acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the IPsec-VPN connection. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
VpnConnectionId	string	Yes	The ID of the IPsec-VPN connection.	vco-p0w2jpkhi2eeop6q6****
RouteEntryType	string	No	The type of the route. Valid values: custom (default): destination route. bgp: BGP route.	custom
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page for paging queries. Default value: 10. Valid values: 1 to 50.	10
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	123e4567-e89b-12d3-a456-4266****

Response elements

Element	Type	Description	Example
	object	The response parameters.
TotalCount	integer	The total number of entries returned.	1
PageNumber	integer	The page number of the list.	1
PageSize	integer	The number of entries per page for paging queries.	10
VcoRouteEntries	array<object>	The list of routes.
	object	The route information.
VpnConnectionId	string	The ID of the IPsec-VPN connection.	vco-p0w2jpkhi2eeop6q6****
RouteDest	string	The destination CIDR block of the route.	192.168.10.0/24
NextHop	string	The next hop of the route.	vco-p0w2jpkhi2eeop6q6****
Weight	integer	The weight of the destination route. Note This parameter is not in use.	100
State	string	The status of the route. published: The destination route is published to the transit router instance. Active: The BGP route is available.	published
RouteEntryType	string	The type of the route. custom: The route is a destination route. bgp: The route is a BGP route.	custom
CreateTime	integer	The timestamp when the destination route was created. The timestamp is in the UNIX format and represents the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1658217008000
AsPath	string	The list of autonomous system (AS) numbers that the BGP route passes through.	[12000]
Community	string	The community value carried by the BGP route.	65535:65510
Source	string	The source of the BGP route. CLOUD: The BGP route is learned by the IPsec-VPN connection from the transit router. VPN_BGP: The BGP route is learned by the IPsec-VPN connection from the on-premises data center.	CLOUD
NextHopTunnelIdList	array	The list of next-hop tunnels. Note This information is returned only for IPsec-VPN connections in dual-tunnel mode. Tunnel information is returned only when the tunnel status is Phase 2 negotiations succeeded.
	string	The tunnel ID.	tun-0jothw962cp3bvhbw****
RequestId	string	The request ID.	E18980E8-C8C2-31BD-8156-AE2BBDEC87E1
VpnRouteCounts	array<object>	The route statistics for the IPsec-VPN connection in dual-tunnel mode. Note This information is returned only for IPsec-VPN connections in dual-tunnel mode.
	object	The route statistics.
RouteEntryType	string	The type of the route. custom: destination route. bgp: BGP route.	bgp
RouteCount	integer	The number of routes.	3
Source	string	The source of the BGP route. CLOUD: The BGP route is learned by the IPsec-VPN connection from the transit router. VPN_BGP: The BGP route is learned by the IPsec-VPN connection from the on-premises data center.	VPN_BGP

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "PageNumber": 1,
  "PageSize": 10,
  "VcoRouteEntries": [
    {
      "VpnConnectionId": "vco-p0w2jpkhi2eeop6q6****",
      "RouteDest": "192.168.10.0/24",
      "NextHop": "vco-p0w2jpkhi2eeop6q6****",
      "Weight": 100,
      "State": "published",
      "RouteEntryType": "custom",
      "CreateTime": 1658217008000,
      "AsPath": "[12000]",
      "Community": "65535:65510",
      "Source": "CLOUD",
      "NextHopTunnelIdList": [
        "tun-0jothw962cp3bvhbw****"
      ]
    }
  ],
  "RequestId": "E18980E8-C8C2-31BD-8156-AE2BBDEC87E1",
  "VpnRouteCounts": [
    {
      "RouteEntryType": "bgp",
      "RouteCount": 3,
      "Source": "VPN_BGP"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.RouteEntryType	The specified RouteEntryType is invalid.	The error message returned because the specified route type is invalid.
400	Vco.StatusNotSupport	The current VPN connection state does not support this operation.	The operation cannot be performed when the VPN connection is in the current state.
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.
403	Forbidden	User not authorized to operate on the specified resource.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.
404	InvalidVpnConnectionInstanceId.NotFound	The specified vpn connection instance id does not exist.	The specified vpn connection instance id does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.