Deletes a destination-based route from an IPsec-VPN connection.

Usage notes

  • The DeleteVcoRouteEntry operation is asynchronous. After you send the request, the system returns a request ID. However, the operation is still being performed in the system background. You can call the DescribeVpnConnection operation to query the status of a route based on the status of the associated IPsec-VPN connection.
    • 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 to delete a route from the same IPsec-VPN connection within the specified period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeleteVcoRouteEntry

The operation that you want to perform. Set the value to DeleteVcoRouteEntry.

RegionId String Yes ap-southeast-2

The ID of the region to which the IPsec-VPN connection belongs.

You can call the DescribeRegions operation to query the most recent region list.

VpnConnectionId String Yes vco-p0w5112fgnl2ihlmf****

The ID of the IPsec-VPN connection.

RouteDest String Yes 192.168.10.0/24

The destination CIDR block of the destination-based route that you want to delete.

Weight Integer Yes 100

The weight of the destination-based route that you want to delete. Valid values:

  • 0: a low priority
  • 100: a high priority
NextHop String Yes vco-p0w5112fgnl2ihlmf****

The next hop of the destination-based route that you want to delete.

OverlayMode String No Ipsec

The tunneling protocol. Set the value to Ipsec, which specifies the IPsec tunneling protocol.

ClientToken String No 123e4567-e89b-12d3-a456-4266****

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. The client token can contain only ASCII characters.

Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId of each API request may be different.

Response parameters

Parameter Type Example Description
RequestId String 9208DDD8-0930-3CE6-AF7F-732B4E67B3DD

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeleteVcoRouteEntry
&RegionId=ap-southeast-2
&VpnConnectionId=vco-p0w5112fgnl2ihlmf****
&RouteDest=192.168.10.0/24
&Weight=100
&NextHop=vco-p0w5112fgnl2ihlmf****
&OverlayMode=Ipsec
&ClientToken=123e4567-e89b-12d3-a456-4266****
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DeleteVcoRouteEntryResponse>
    <RequestId>9208DDD8-0930-3CE6-AF7F-732B4E67B3DD</RequestId>
</DeleteVcoRouteEntryResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "9208DDD8-0930-3CE6-AF7F-732B4E67B3DD"
}

Error codes

HttpCode Error code Error message Description
400 Resource.QuotaFull The quota of resource is full The error message returned because the resource quota is reached.
400 VpnRouteEntry.Conflict The specified route entry has conflict. The error message returned the specified route conflicts with an existing route.
403 Forbbiden.SubUser User not authorized to operate on the specified resource as your account is created by another user. The error message returned because 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. The error message returned because you are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again.
404 InvalidVpnConnectionInstanceId.NotFound The specified vpn connection instance id does not exist. The error message returned because the specified IPsec-VPN connection does not exist. Check whether the ID of the IPsec-VPN connection is valid.

For a list of error codes, visit the API Error Center.