Delete a destination-based route using DeleteVcoRouteEntry - VPN Gateway - Alibaba Cloud - VPN Gateway

Calls the DeleteVcoRouteEntry operation to delete a destination route entry from an IPsec connection.

Operation description

The DeleteVcoRouteEntry operation is asynchronous. After you send a request, the system returns a request ID, but the destination route entry is not immediately deleted. The deletion task runs in the background. You can call DescribeVpnConnection to query the deletion status of the destination route entry:
- If the IPsec connection is in the updating state, the destination route entry is being deleted.
- If the IPsec connection is in the attached state, the destination route entry is deleted.
The DeleteVcoRouteEntry operation does not support concurrent deletion of destination route entries from the same IPsec connection.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DeleteVcoRouteEntry

delete

*VpnConnections

acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the IPsec connection. You can call DescribeRegions to query region IDs.	cn-hangzhou
VpnConnectionId	string	Yes	The ID of the IPsec connection.	vco-p0w5112fgnl2ihlmf****
RouteDest	string	Yes	The destination CIDR block of the destination route entry to be deleted.	192.168.10.0/24
Weight	integer	Yes	The weight of the destination route entry to be deleted. Valid values: 0: low priority. 100: high priority.	100
NextHop	string	Yes	The next hop of the destination route entry to be deleted.	vco-p0w5112fgnl2ihlmf****
OverlayMode	string	No	The tunneling protocol. Set the value to Ipsec (default), 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 ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId value as the ClientToken value. The RequestId value is different for each API request.	123e4567-e89b-12d3-a456-4266****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	9208DDD8-0930-3CE6-AF7F-732B4E67B3DD

Examples

Success response

JSON format

{
  "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
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.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.