Virtual Private Cloud
Virtual Private Cloud
Document
- Documentation
Virtual Private CloudAPIRoute TableCreateRouteEntry - Creating a route entry
Copy page
Download PDFRoute Table
CreateRouteEntry - Creating a route entry
Copy pageDownload PDFCreateRouteEntry - Creating a route entry
Call the CreateRouteEntry API to add a custom route entry to the route table.
Instructions
- A single route table can create up to 200 custom route entries by default. If the default quota cannot meet your needs, go to the Quota Center to increase the corresponding quota.
- CreateRouteEntry is an asynchronous API. When a request ID is returned, the system is still configuring in the background. You can call DescribeRouteEntryList to check the status of route entries; Pending means configuring, and Available means configuration complete.
Debug
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
The table below lists only the request parameters unique to this API and some common parameters. For more information, see Common parameters.
Action String required Example: CreateRouteEntry
The API name. The current API name is CreateRouteEntry.
Version String required Example: 2020-04-01
The API version. The current API version is 2020-04-01.
RouteTableId String required Example: vtb-2fdzao4h726f45oxruw******
Route table ID.
RouteEntryName String optional Example: route-entry-1
Route entry name.
- The name must start with a letter, Chinese character, or number. It may contain periods (.), underscores (_), and hyphens (-).
- Length limit: 1 to 128 characters
- If left blank, this defaults to an empty string.
Description String optional Example: This is first route entry
Description of the route entry.
- Must start with a letter, Chinese character, or number. It may include half-width commas (,), periods (.), underscores (_), spaces ( ), equal signs (=), hyphens (-), full-width commas (，), and full-width periods (。).
- Length limit: 0 to 255 characters.
- If left blank, this defaults to an empty string.
NextHopName String optional Example: eni-01
Name of the next hop resource for the route entry.
NextHopType String required Example: NetworkInterface
- Subnet route table: The next hop type for custom route entries. Valid values:
- Instance: ECS instance.
- HaVip: High-Availability Virtual IP Address.
- NetworkInterface: Secondary network interface.
- NatGW: NAT Gateway.
- VpnGW: VPN Gateway.
- TransitRouter: Transit Router.
- IPv6GW: IPv6 Gateway.
- CloudConnector: Cloud Connector.
- GWLBEndpoint: Gateway Load Balancer Endpoint.
- Gateway route table: The next hop type for custom route entries. Valid values:
- NetworkInterface: Secondary network interface.
- GWLBEndpoint: Gateway Load Balancer Endpoint.
tip
- Gateway Load Balancer, Cloud Connector, IPv6 Gateway, and Gateway Route Table are in the invite-only Beta stage. For a trial, contact your account manager.
- Custom subnet route tables support GWLBEndpoint as a valid parameter. When the destination CIDR of a GWLBEndpoint matches that of a local route, the GWLBEndpoint route takes precedence.
- If GWLBEndpoint is specified as the NextHopType in a gateway route table, the DestinationCidrBlock can be a subset of the subnet CIDR (e.g., /32).
NextHopId String optional Example: eni-2fdzbqxfwrt345oxru******
Next hop resource ID.
Provide the correct resource ID based on the next hop type.
DestinationCidrBlock String optional Example: 8.XX.XX.8/32
The destination CIDR block of the route entry.
tip
- When NextHopType is set to "IPv6GW", this parameter can only be ::/0.
- At least one of the parameters DestinationCidrBlock and DestinationPrefixListId must be provided.
DestinationPrefixListId String optional Example: pl-bp1fg655nh68xyz9****
ID of the prefix list.
tip
- At least one of the parameters DestinationCidrBlock and DestinationPrefixListId must be provided.
- Gateway route tables do not support this parameter.
ClientToken String optional Example: 123e4567-e89b-12d3-a456-42665544****
Client token: Used to ensure request idempotency.
- You can use the client to automatically generate a token, but you must make sure that the token is unique among different requests. This prevents repeated actions due to multiple client retries when the call of the API action times out or an internal server error occurs.
- Must not exceed 64 ASCII characters.
- If no ClientToken passed in, the API call does not verify idempotency.
Response parameters
Only the response parameters specific to this API are listed below. For more information, see Response structure.
RouteEntryId String Example: rte-3tj9gw2pwq3vj0******
ID of the newly added route entry.
RequestId String Example: 2021062415303301022514515207C4****
Request ID.
Request example
Response example
Error codes
Last updated: 2026.10.28 15:22:03
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
