Use CreateEnsRouteEntry to add a custom route entry - ENS

Creates a custom route entry.

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:CreateEnsRouteEntry

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RouteTableId	string	Yes	The ID of the route table to which you want to add a custom route entry.	vtb-bp1cifr72dioje82lse2j
DestinationCidrBlock	string	Yes	The destination CIDR block of the custom route entry. Make sure that the following requirements are met: The destination CIDR block cannot point or belong to 100.64.0.0/10. The destination CIDR blocks of the custom route entries in the same route table cannot overlap. 0.0.0.0/0 indicates the default CIDR block.	120.XXX.XXX.0/24
NextHopType	string	No	The next hop type of the custom route. Valid values: Instance: an ENS instance. HaVip: a high-availability virtual IP address (HAVIP). NetworkPeer: VPC peering connection.	Instance
NextHopId	string	Yes	The ID of the next hop of the custom route entry.	i-5vb7leks9z4mxy1ay258
RouteEntryName	string	No	The name of the custom route entry that you want to add. The name must be 1 to 128 characters in length. It cannot start with http:// or https://.	test
Description	string	No	The description of the custom route entry.	example
SourceCidrBlock	string	No	The source CIDR block is available when you configure a route entry in the gateway route table, but is not unavailable when you configure a route entry in the vSwitch route table.	172.XXX.XXX.0/24

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
RouteEntryId	string	The ID of the route.	rte-5vb5q8sk0lyoscx8539ds

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "RouteEntryId": "rte-5vb5q8sk0lyoscx8539ds"
}

Error codes

HTTP status code	Error code	Error message	Description
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	InvalidRouteTableId.NotFound	Specified route table does not exist.	The routing table does not exist.
400	IncorrectStatus.Network	The status of the network is incorrect.	The status of the network is incorrect.
400	InvalidNetworkType.NotSupported	The specified network type does not supported.	The network type is not supported.
400	QuotaExceeded	Route entry quota exceeded in this route table.	The number of route entries in the routing table exceeds the limit.
400	InvalidRouteEntry.Duplicate	The route entry already exists.	The specified route entry already exists.
400	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	The specified instance does not exist.
400	InvalidCidrBlock.Malformed	Specified CIDR block is not valid.	The format of the destination network segment is incorrect.
400	InvalidSourceCidrBlock.Malformed	Specified Source CIDR Block is not valid.	The format of the source network segment is incorrect.
400	InvalidSourceCidrBlock.NotSupported	The route table does not support the source CIDR block parameter.	The routing table does not support the source CIDR block parameter.
400	InvalidNextHopType.NotSupported	This next hop type is not supported.	This next hop type is not supported.
400	HaVipNotFound	The input parameter haVipId that is not found.	The specified HaVip does not exist.
400	IncorrectHaVipStatus	The status of the haVip is invalid.	HaVip status is incorrect
400	InstanceNotFound.NetworkPeerConnection	Network peer connection not found, please check the InstanceId.	The instance cannot be found, please check the instance ID.
400	IncorrectStatus.NetworkPeerConnection	The status of the network peer connection is incorrect.	The status of the network peer connection is incorrect.
400	IncorrectNetworkInterfaceStatus	The operation could not be completed because the status of the specified network interface is invalid for this action.	The operation could not be completed because the status of the specified network interface is invalid for this action.
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.