Use DescribeEnsRouteEntryList to query route entries - ENS

Queries route entries.

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

ens:DescribeEnsRouteEntryList

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RouteTableId	string	No	The ID of the route table that you want to query.	vtb-hp3wdhynneo7fsclox8hs
RouteEntryId	string	No	The ID of the route that you want to query.	rte-8vbdw66evgv44u2u7v3hx
DestinationCidrBlock	string	No	The destination Classless Inter-Domain Routing (CIDR) block of the route entry.	11.0.0.0/16
RouteEntryType	string	No	The route type. Valid values: Custom: custom route System: system route	Custom
NextHopType	string	No	The type of next hop of the custom route entry. Valid values: Instance (default): an ENS instance. HaVip: a high-availability virtual IP address (HAVIP). NetworkPeer: VPC peering connection.	Instance
NextHopId	string	No	The ID of the next hop.	i-2zecshuv3axtr2gc4noa
RouteEntryName	string	No	The name of the route.	test0
PageNumber	integer	No	The page number of the returned page. Valid values: integers that are greater than 0. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Valid values: 10 to 100.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
RouteEntrys	array<object>	The information about the routes.
	array<object>	The information about the route.
Status	string	The status of the route entry. Valid values:	Available
Type	string	The type of the route entry.	Custom
Description	string	Enter a description for the route.	Test
RouteEntryName	string	The name of the route.	test0
DestinationCidrBlock	string	The destination CIDR block of the route.	101.0.45.0/24
RouteEntryId	string	The ID of the route.	rte-2zeksx7h436f5unk349m1
RouteTableId	string	The ID of the route table.	vtb-uf62p9o5cn35fi8xgurnm
NextHops	array<object>	The information about the next hop.
	object	The next hop.
NextHopId	string	The ID of the next hop.	i-bp1111yup9991890woxq
NextHopType	string	The type of the next hop. Valid values:	Instance
NextHopName	string	The instance ID of the next hop.	testInstance
SourceCidrBlock	string	The source CIDR block. This field is used when you configure a route entry in the gateway route table. This field is not supported in the vSwitch route table.	10.XXX.XXX.0/24
CreationTime	string	The time when the IP address was created. The time is displayed in UTC.	2023-02-16T03:50:05Z
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The number of returned entries.	7

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "RouteEntrys": [
    {
      "Status": "Available",
      "Type": "Custom",
      "Description": "Test",
      "RouteEntryName": "test0",
      "DestinationCidrBlock": "101.0.45.0/24",
      "RouteEntryId": "rte-2zeksx7h436f5unk349m1",
      "RouteTableId": "vtb-uf62p9o5cn35fi8xgurnm",
      "NextHops": [
        {
          "NextHopId": "i-bp1111yup9991890woxq",
          "NextHopType": "Instance",
          "NextHopName": "testInstance"
        }
      ],
      "SourceCidrBlock": "10.XXX.XXX.0/24",
      "CreationTime": "2023-02-16T03:50:05Z"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 7
}

Error codes

HTTP status code	Error code	Error message
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.