All Products
Search
Document Center

:DeleteVcoRouteEntry

最終更新日:Sep 01, 2023

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

Usage notes

  • 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. 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 region ID of the IPsec connection.

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 token, but you must make sure that the token is unique among different requests. The 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.

Response parameters

Parameter

Type

Example

Description

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

The request ID.

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 resource quota is exhausted.
400 VpnConnection.Configuring The specified service is configuring. The operation is not allowed when the specified service is being configured. Try again later.
400 VpnConnection.FinancialLocked The specified service is financial locked. 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. The specified route conflicts with an existing route.
400 InvalidRouteEntry.NotFound The specified route entry does not exist. The route is not found.
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. You can apply for the required permissions and try again.
403 Forbidden User not authorized to operate on the specified resource. You are unauthorized to perform this operation on the specified resource. You can apply for the required permissions and try again.
404 InvalidVpnConnectionInstanceId.NotFound The specified vpn connection instance id does not exist. 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, see Service error codes.