All Products
Search

This Product

    Virtual Private Cloud:DeleteVpnPbrRouteEntry

    Document Center

    Virtual Private Cloud:DeleteVpnPbrRouteEntry

    Last Updated:Nov 13, 2024

    Deletes a policy-based route from a VPN gateway.

    Operation description

    • DeleteVpnPbrRouteEntry 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 DescribeVpnGateway to query the status of the task.

      • 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

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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:DeleteVpnPbrRouteEntry
    • VpnGateway
      acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

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

    		cn-hangzhou
    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****
    VpnGatewayIdstringYes

    The ID of the VPN gateway.

    		vpn-bp1a3kqjiiq9legfx****
    RouteSourcestringYes

    The source CIDR block of the policy-based route.

    		192.168.1.0/24
    RouteDeststringYes

    The destination CIDR block of the policy-based route.

    		10.0.0.0/24
    NextHopstringYes

    The next hop of the policy-based route.

    		vco-bp15oes1py4i66rmd****
    WeightintegerYes

    The weight of the policy-based route. Valid values:

    You can call DescribeVpnPbrRouteEntries to query weights of policy-based routes.

    		0
    OverlayModestringNo

    The tunneling protocol. Set the value to Ipsec.

    		Ipsec
    PriorityintegerNo

    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 specify this parameter, set the value to the priority configured for the policy-based route. Otherwise, the operation cannot be performed.
    		10

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		5BE01CD7-5A50-472D-AC14-CA181C5C03BE

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400Resource.QuotaFullThe quota of resource is fullThe resource quota is exhausted.
    400VpnGateway.ConfiguringThe specified service is configuring.The service is being configured. Try again later.
    400VpnGateway.FinancialLockedThe specified service is financial locked.The service is suspended due to overdue payments. Top up your account first.
    400VpnRouteEntry.AlreadyExistsThe specified route entry is already exist.The route already exists.
    400VpnRouteEntry.ConflictThe specified route entry has conflict.Route conflicts exist.
    400VpnRouteEntry.ConfiguringThe specified route entry is configuring.The error message returned because the specified route is being configured.
    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.
    400VpnTask.CONFLICTVpn task has conflict.The VPN operation conflicts. 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.
    404InvalidVpnGatewayInstanceId.NotFoundThe specified vpn gateway instance id does not exist.The specified VPN gateway does not exist. Check whether the specified VPN gateway is valid.

    For a list of error codes, visit the Service error codes.