Creates a custom route entry.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ens:CreateEnsRouteEntry | create | *All Resources * |
| 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:
| 0.0.0.0/0 |
| NextHopType | string | No | The next hop type of the custom route. Valid values:
| 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 parameters
Examples
Sample success responses
JSONformat
{
"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. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-03-13 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2025-01-10 | The Error code has changed | View Change Details |
| 2024-11-05 | The Error code has changed | View Change Details |