Creates a destination-based route entry for a VPN gateway.
Operation description
-
CreateVpnRouteEntry is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call DescribeVpnGateway to query the status of the task.
- If a VPN gateway is in the updating state, the destination-based route entry is being created.
- If a VPN gateway is in the active state, the destination-based route entry has been created.
-
You cannot repeatedly call CreateVpnRouteEntry to create a destination-based route entry for a VPN gateway within the specified period of time.
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:
- The required resource types are displayed in bold characters.
- 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 |
|---|---|---|---|---|
| vpc:CreateVpnRouteEntry | create |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The ID of the region where the VPN gateway is created. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
| d7d24a21-f4ba-4454-9173-b3828dae**** |
| VpnGatewayId | string | Yes | The ID of the VPN gateway. | vpn-bp1a3kqjiiq9legfx**** |
| RouteDest | string | Yes | The destination CIDR block of the destination-based route. | 10.0.0.0/24 |
| NextHop | string | Yes | The next hop of the destination-based route. | vco-bp15oes1py4i66rmd**** |
| Weight | integer | Yes | The weight of the destination-based route. Valid values:
| 0 |
| PublishVpc | boolean | Yes | Specifies whether to advertise the destination-based route to a virtual private cloud (VPC) route table. Valid values:
| true |
| Description | string | No | The description of the destination-based route. The description must be 1 to 100 characters in length, and cannot start with | mytest |
| OverlayMode | string | No | The tunneling protocol. The value is set to Ipsec, which indicates the IPsec tunneling protocol. | Ipsec |
Response parameters
Examples
Sample success responses
JSONformat
{
"NextHop": "vco-bp15oes1py4i66rmd****",
"Weight": 0,
"RouteDest": "10.0.0.0/24",
"RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE",
"Description": "mytest",
"State": "published",
"CreateTime": 1492747187000,
"OverlayMode": "Ipsec",
"VpnInstanceId": "vpn-bp1a3kqjiiq9legfx****"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Resource.QuotaFull | The quota of resource is full | The resource quota is exhausted. |
| 400 | VpnGateway.Configuring | The specified service is configuring. | The service is being configured. Try again later. |
| 400 | VpnGateway.FinancialLocked | The specified service is financial locked. | The service is suspended due to overdue payments. Top up your account first. |
| 400 | VpnRouteEntry.AlreadyExists | The specified route entry is already exist. | The route already exists. |
| 400 | VpnRouteEntry.Conflict | The specified route entry has conflict. | Route conflicts exist. |
| 400 | VpnRouteEntry.ConflictSSL | The specified route entry has conflict with SSL client. | The route conflicts with the SSL client. |
| 400 | VpnRouteEntry.BackupRoute | Validate backup route entry failed. | Active/standby routes failed authentication. |
| 400 | VpnRouteEntry.InvalidWeight | Invalid route entry weight value. | The weight specified for the route is invalid. |
| 400 | InvalidNextHop.NotFound | The specified NextHop does not exist. | The specified next hop does not exist. |
| 400 | IllegalParam.RouteDest | The specified RouteDest is invalid | The destination address is invalid. |
| 400 | OperationFailed.RouteConflict | Operation failed because there is already a route in VPC route table to another VPN on the same network block. | Operation failed because there is already a route in VPC route table to another VPN on the same network block. |
| 400 | OperationFailed.InvalidCidrBlock | Operation failed because the specified network block is invalid. | The CIDR block is invalid. |
| 400 | OperationFailed.RouteConflict | Operation failed because there is already a route in VPC route table to a non-RI and non-VPN next hop on the same network block. | Routes that point to resources other than the router interface or VPN gateway already exists on the same CIDR block in the route table of the VPC. |
| 400 | QuotaExceeded.VpnRouteEntry | The number of route entries to the VPN gateway in the VPC routing table has reached the quota limit. | The number of route entries to the VPN gateway in the VPC routing table has reached the quota limit. |
| 400 | TaskConflict | The operation is too frequent, please wait a moment and try again. | Your requests are too frequent. Try again later. |
| 400 | VpnTask.CONFLICT | Vpn task has conflict. | The VPN operation conflicts. Try again later. |
| 400 | IncorrectVpcStatus | Current VPC status does not support this operation. | This operation cannot be performed when the VPC is in the current state. |
| 400 | InternalError | The request processing has failed due to some unknown error, exception or failure. | An internal error occurred. |
| 403 | Forbbiden.SubUser | User not authorized to operate on the specified resource as your account is created by another user. | You are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again. |
| 403 | Forbidden | User not authorized to operate on the specified resource. | You do not have the permissions to manage the specified resource. Apply for the permissions and try again. |
| 404 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id does not exist. | The specified VPN gateway does not exist. Check whether the specified VPN gateway is valid. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-05-10 | API Description Update. The Error code has changed | View Change Details |