Deletes a destination-based route from an IPsec-VPN connection.
Operation description
-
DeleteVcoRouteEntry 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 the DescribeVpnConnection operation to query the status of the task.
- If the IPsec-VPN connection is in the updating state, the route is being deleted.
- If the IPsec-VPN connection is in the attached state, the route is deleted.
-
You cannot repeatedly call the DeleteVcoRouteEntry operation within a specific time period.
Debugging
Authorization information
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The ID of the region where the IPsec-VPN connection is established. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| VpnConnectionId | string | Yes | The ID of the IPsec-VPN attachment. | vco-p0w5112fgnl2ihlmf**** |
| RouteDest | string | Yes | The destination CIDR block of the destination-based route that you want to delete. | 192.168.10.0/24 |
| Weight | integer | Yes | The weight of the destination-based route that you want to delete. Valid values:
| 100 |
| NextHop | string | Yes | The next hop of the destination-based route that you want to delete. | vco-p0w5112fgnl2ihlmf**** |
| OverlayMode | string | No | The tunneling protocol. Set the value to Ipsec, which specifies the IPsec tunneling protocol. | Ipsec |
| 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.
| 123e4567-e89b-12d3-a456-4266**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "9208DDD8-0930-3CE6-AF7F-732B4E67B3DD"
}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 | VpnConnection.Configuring | The specified service is configuring. | The service is being configured. Try again later. |
| 400 | VpnConnection.FinancialLocked | The specified service is financial locked. | The error message returned because the service is locked due to overdue payments. |
| 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 | InvalidRouteEntry.NotFound | The specified route entry does not exist. | The error message returned because the specified route does not exist. |
| 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 | InvalidVpnConnectionInstanceId.NotFound | The specified vpn connection instance id does not exist. | The specified vpn connection instance id does not exist. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-08-02 | API Description Update. The Error code has changed | View Change Details |