Queries information about route entries in a route table.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeRouteEntryList

The operation that you want to perform. Set the value to DescribeRouteEntryList.

RegionId String Yes cn-hangzhou

The region of the route table to which the route entry belongs. You can call the DescribeRegions operation to query the region IDs.

RouteTableId String Yes vtb-bp1r9pvl4xen8s9ju****

The ID of the route table that you want to query.

RouteEntryId String No rte-bp1mnnr2al0naomnp****

The ID of the route entry that you want to query.

DestinationCidrBlock String No 192.168.2.0/24

The destination CIDR block of the route entry. IPv4 and IPv6 CIDR blocks are supported.

Note Only the Alibaba Cloud China site supports IPv6 CIDR blocks.
RouteEntryName String No abc

The name of the route entry.

IpVersion String No IPv4

The version of the IP protocol. Valid values:

  • IPv4 : indicates the IPv4 protocol.
  • IPv6: indicates the IPv6 protocol.
Note Only the Alibaba Cloud China site supports the IPv6 protocol.
RouteEntryType String No System

The type of the route entry. Valid values:

  • Custom: indicates a custom route entry.
  • System : indicates a system route entry.
NextHopId String No vpn-bp10zyaph5cc8b7c7****

The ID of the next hop.

NextHopType String No Instance

The type of the next hop. Valid values:

  • Instance: The next hop is an ECS instance
  • HaVip: The next hop is a highly available virtual IP address (HAVIP).
  • VpnGateway: The next hop is a VPN gateway.
  • NatGateway: The next hop is a NAT gateway.
  • NetworkInterface: The next hop is a secondary elastic network interface (ENI).
  • RouterInterface: The next hop is a router interface.
  • IPv6Gateway: The next hop is an IPv6 gateway.
Note Only the Alibaba Cloud China site supports IPv6 gateways as next hops.
MaxResult Integer No 50

The number of entries to return on each page. Valid values:20 to 100. Default value: 50.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The token that you specify to start the next query.

Response parameters

Parameter Type Example Description
NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token that is returned for the next query.

RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A

The ID of the request.

RouteEntrys Array

The information about the route entry.

RouteEntry
Description String RouteEntryDescription

The description of the VRouter.

DestinationCidrBlock String 10.0.0.0/24

The destination Classless Inter-Domain Routing (CIDR) block of the route entry.

IpVersion String IPv4

The version of the IP protocol. Valid values:

  • IPv4 : the IPv4 protocol
  • IPv6: the IPv6 protocol.
NextHops Array

The information about the next hop.

NextHop
Enabled Integer 0

Indicates whether the route entry is available.

  • 0: The route entry is unavailable.
  • 1: The route entry is available.
NextHopId String vpn-bp10zyaph5cc8b7c7****

The ID of the next hop.

NextHopRegionId String cn-hangzhou

The region where the next hop instance is deployed.

NextHopRelatedInfo Struct

The information about the next hop.

InstanceId String vpc-bp1t36rn9l53iwbsf****

The ID of the instance associated with the next hop.

InstanceType String VPC

The type of the instance associated with the next hop.

  • VPC: the next hop is a VPC.
  • VBR: The next hop is a virtual border router (VBR).
RegionId String ch-hangzhou

The region of the instance associated with the next hop.

NextHopType String Instance

The type of the next hop. Valid values:

  • Instance: The next hop is an ECS instance.
  • HaVip: The next hop is an HAVIP.
  • VpnGateway: The next hop is a VPN gateway.
  • NatGateway: The next hop is a NAT gateway.
  • NetworkInterface: The next hop is a secondary ENI.
  • RouterInterface: The next hop is a router interface.
  • IPv6Gateway: The next hop is an IPv6 gateway.
Note Only the Alibaba Cloud China site supports IPv6 gateways as next hops.
Weight Integer 100

The weight of the route entry.

RouteEntryId String rte-bp1mnnr2al0naomnp****

The ID of the route entry.

RouteEntryName String aaa

The name of the route entry.

RouteTableId String vtb-bp15w5q90d2rk3bww****

The ID of the route table.

Status String Available

The status of the route entry.

  • Pending: The route entry is being configured.
  • Available: The route entry is available for use.
  • Modifying: The route entry is being modified.
Type String Custom

The type of the route entry.

  • Custom: a custom route entry.
  • System : a system route entry.

Examples

Sample requests

http(s)://vpc.aliyuncs.com/? Action=DescribeRouteEntryList
&RegionId=cn-hangzhou
&RouteTableId=vtb-bp1r9pvl4xen8s9ju****
&<Common request parameters>

Sample success responses

XML format

<DescribeRouteEntryListResponse>
	  <NextToken></NextToken>
	  <RouteEntrys>
		    <RouteEntry>
			      <NextHops>
				        <NextHop>
					          <NextHopId>eni-bp16v0fuhulfl5e1****</NextHopId>
					          <NextHopRelatedInfo></NextHopRelatedInfo>
					          <NextHopType>NetworkInterface</NextHopType>
				        </NextHop>
			      </NextHops>
			      <Status>Available</Status>
			      <RouteEntryName>ENI</RouteEntryName>
			      <RouteEntryId>rte-bp1aejenqyg5zcmv4****</RouteEntryId>
			      <Type>Custom</Type>
			      <IpVersion>ipv4</IpVersion>
			      <RouteTableId>vtb-bp15w5q90d2rk3bww****</RouteTableId>
			      <DestinationCidrBlock>103.0.0.0/32</DestinationCidrBlock>
		    </RouteEntry>
	  </RouteEntrys>
	  <RequestId>57828ADD-F0C4-4125-AF79-6556D44C5277</RequestId>
</DescribeRouteEntryListResponse>

JSON format

{
	"NextToken": "",
	"RouteEntrys": {
		"RouteEntry": [
			{
				"NextHops": {
					"NextHop": [
						{
							"NextHopId": "eni-bp16v0fuhulfl5e1****",
							"NextHopRelatedInfo": {},
							"NextHopType": "NetworkInterface"
						}
					]
				},
				"Status": "Available",
				"RouteEntryName": "ENI",
				"RouteEntryId": "rte-bp1aejenqyg5zcmv4****",
				"Type": "Custom",
				"IpVersion": "ipv4",
				"RouteTableId": "vtb-bp15w5q90d2rk3bww****",
				"DestinationCidrBlock": "103.0.0.0/32"
			}
		]
	},
	"RequestId": "57828ADD-F0C4-4125-AF79-6556D44C5277"
}

Error codes

For a list of error codes, visit the API Error Center.