All Products
Search
Document Center

VPN Gateway:DeleteVcoRouteEntry

Last Updated:Mar 01, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DeleteVcoRouteEntryWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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.

ap-southeast-2
VpnConnectionIdstringYes

The ID of the IPsec-VPN attachment.

vco-p0w5112fgnl2ihlmf****
RouteDeststringYes

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

192.168.10.0/24
WeightintegerYes

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

  • 0: a low priority
  • 100: a high priority
100
NextHopstringYes

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

vco-p0w5112fgnl2ihlmf****
OverlayModestringNo

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

Ipsec
ClientTokenstringNo

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

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

9208DDD8-0930-3CE6-AF7F-732B4E67B3DD

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400Resource.QuotaFullThe quota of resource is fullThe resource quota is exhausted.
400VpnConnection.ConfiguringThe specified service is configuring.The service is being configured. Try again later.
400VpnConnection.FinancialLockedThe specified service is financial locked.The error message returned because the service is locked due to overdue payments.
400VpnRouteEntry.AlreadyExistsThe specified route entry is already exist.The route already exists.
400VpnRouteEntry.ConflictThe specified route entry has conflict.Route conflicts exist.
400InvalidRouteEntry.NotFoundThe specified route entry does not exist.The error message returned because the specified route does not exist.
400TaskConflictThe operation is too frequent, please wait a moment and try again.Your requests are too frequent. Try again later.
403Forbbiden.SubUserUser 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.
403ForbiddenUser 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.
404InvalidVpnConnectionInstanceId.NotFoundThe 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 timeSummary of changesOperation
2023-08-02API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404