Deletes a destination-based route from a VPN gateway.
Operation description
-
DeleteVpnRouteEntry 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 is being deleted.
- If the VPN gateway is in the active state, the destination-based route is deleted.
-
You cannot repeatedly call DeleteVpnRouteEntry to delete a destination-based route from a VPN gateway within the specified period of time.
Debugging
Authorization information
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-b3828dae492b |
| 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 |
| OverlayMode | string | No | The tunneling protocol. Set the value to Ipsec. | Ipsec |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE\t"
}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.Configuring | The specified route entry is configuring. | The error message returned because the specified route is being configured. |
| 400 | InvalidRouteEntry.NotFound | The specified route entry does not exist. | The error message returned because the specified route does not exist. |
| 400 | VpnTask.CONFLICT | Vpn task has conflict. | The VPN operation conflicts. Try again later. |
| 400 | TaskConflict | The operation is too frequent, please wait a moment and try again. | Your requests are too frequent. Try again later. |
| 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.