Deletes a policy-based route from a VPN gateway.

Usage notes

  • The DeleteVpnPbrRouteEntry operation is asynchronous. After you call the operation, the request ID is returned but the operation is still being performed in the system background. You can call DescribeVpnGateway to query the status of a VPN gateway.
    • If a VPN gateway is in the updating state, the policy-based route is being deleted.
    • If a VPN gateway is in the active state, the policy-based route has been deleted.
  • You cannot repeatedly call DeleteVpnPbrRouteEntry to delete a policy-based route 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 DeleteVpnPbrRouteEntry

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

RegionId String Yes cn-hangzhou

The ID of the region where the VPN gateway is created. You can call the DescribeRegions operation to query the most recent region list.

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 the value 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 RequestId as ClientToken. The value of RequestId may be different for each API request.
VpnGatewayId String Yes vpn-bp1a3kqjiiq9legfx****

The ID of the VPN gateway.

RouteSource String Yes 192.168.1.0/24

The source CIDR block of the policy-based route.

RouteDest String Yes 10.0.0.0/24

The destination CIDR block of the policy-based route.

NextHop String Yes vco-bp15oes1py4i66rmd****

The next hop of the policy-based route.

Weight Integer Yes 0

The weight of the policy-based route.

OverlayMode String No Ipsec

The tunneling protocol. Set the value to Ipsec.

Priority Integer No 10

The priority of the policy-based route.

  • If the route was not assigned a priority, this parameter is optional.

  • If the route was assigned a priority, this parameter is optional.

    If you set this parameter, set the value to the priority that was assigned to the route. Otherwise, the operation fails.

Response parameters

Parameter Type Example Description
RequestId String 5BE01CD7-5A50-472D-AC14-CA181C5C03BE

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeleteVpnPbrRouteEntry
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-4266****
&VpnGatewayId=vpn-bp1a3kqjiiq9legfx****
&RouteSource=192.168.1.0/24
&RouteDest=10.0.0.0/24
&NextHop=vco-bp15oes1py4i66rmd****
&Weight=0
&OverlayMode=Ipsec
&Priority=10
&Common request parameters

Sample success responses

XML format

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

<DeleteVpnPbrRouteEntryResponse>
    <RequestId>5BE01CD7-5A50-472D-AC14-CA181C5C03BE</RequestId>
</DeleteVpnPbrRouteEntryResponse>

JSON format

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

{
  "RequestId" : "5BE01CD7-5A50-472D-AC14-CA181C5C03BE"
}

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 VpnGateway.Configuring The specified service is configuring. The error message returned because the specified service is being configured. Try again later.
400 VpnGateway.FinancialLocked The specified service is financial locked. The error message returned because the service is suspended due to overdue payments. Top up your account before you use the service.
400 VpnRouteEntry.AlreadyExists The specified route entry is already exist. The error message returned because the route already exists.
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 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist. The error message returned because the specified VPN gateway does not exist. Check whether the specified VPN gateway is valid.

For a list of error codes, see Service error codes.