All Products
Search
Document Center

VPN Gateway:ModifyVpnRouteEntryWeight

Last Updated:Oct 08, 2026

Modifies the weight of a destination route.

Operation description

Note

This operation is applicable only to VPN gateway instances that support single-tunnel IPsec-VPN connections. For VPN gateway instances that support dual-tunnel IPsec-VPN connections, the modified weight does not take effect even if the operation is successful.

  • If active/standby destination routes exist under a VPN gateway instance and you want to modify the weight of the active destination route, you must delete the standby destination route first. After the active destination route is modified, reconfigure the standby destination route. If you want to modify the weight of the standby destination route, you must delete the active destination route first. After the standby destination route is modified, reconfigure the active destination route. To delete a destination route, refer to DeleteVpnRouteEntry.

  • The ModifyVpnRouteEntryWeight operation is asynchronous. The system returns a request ID, but the weight of the VPN destination route is not immediately modified and the modification task is still running in the background. You can call the DescribeVpnGateway operation to query the modification status of the weight of the VPN destination route:
    • If the VPN destination route is in the updating state, the weight of the VPN destination route is being modified.

    • If the VPN destination route is in the active state, the weight of the VPN destination route is modified.

  • The ModifyVpnRouteEntryWeight operation does not support concurrent modification of the weights of destination routes under the same VPN gateway.

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:ModifyVpnRouteEntryWeight

update

*VpnGateway

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID of the VPN gateway instance. You can call the DescribeRegions operation to query region IDs.

cn-hangzhou

ClientToken

string

No

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 ensure that it 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 RequestId of the API request as the ClientToken. The RequestId of each API request is unique.

d7d24a21-f4ba-4454-9173-b3828dae492b

VpnGatewayId

string

Yes

The ID of the VPN gateway.

vpn-bp1a3kqjiiq9legfx****

RouteDest

string

Yes

The destination CIDR block of the destination route.

10.0.0.0/24

NextHop

string

Yes

The next hop of the destination route.

vco-bp15oes1py4i66rmd****

Weight

integer

Yes

The weight of the destination route before the modification. Valid values:

  • 0: low priority.

  • 100: high priority.

0

NewWeight

integer

Yes

The new weight of the destination route. Valid values:

  • 0: low priority.

  • 100: high priority.

100

OverlayMode

string

No

The tunnel protocol. Set the value to Ipsec (IPsec tunnel protocol).

Ipsec

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

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

Examples

Success response

JSON format

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

Error codes

HTTP status code

Error code

Error message

Description

400 Resource.QuotaFull The quota of resource is full
400 VpnGateway.Configuring The specified service is configuring.
400 VpnGateway.FinancialLocked The specified service is financial locked.
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 VpnRouteEntry.BackupRoute Validate backup route entry failed. Active/standby routes failed authentication.
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 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.