Modify the weight of a policy-based route - VPN Gateway - Alibaba Cloud - VPN Gateway

Modifies the weight of a VPN policy-based 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.

In scenarios where active and standby policy-based routing exists under a VPN gateway instance, if you want to modify the weight of the active policy-based routing, you must first delete the standby policy-based routing. After the active policy-based routing is modified, reconfigure the standby policy-based routing. If you want to modify the weight of the standby policy-based routing, you must first delete the active policy-based routing. After the standby policy-based routing is modified, reconfigure the active policy-based routing. To delete policy-based routing, refer to DeleteVpnPbrRouteEntry.
ModifyVpnPbrRouteEntryWeight is an asynchronous operation. The system returns a request ID, but the policy-based routing is not immediately modified. The modification node is still running in the background. You can invoke the DescribeVpnGateway operation to query the instance status of the VPN gateway and determine the modification status of the policy-based routing:
- If the VPN gateway instance is in the updating state, the policy-based routing is being modified.
- If the VPN gateway instance is in the active state, the policy-based routing is modified.
The ModifyVpnPbrRouteEntryWeight operation does not support concurrent modification of policy-based routing under the same VPN gateway instance.

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

update

*VpnGateway

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

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 generate the parameter value from your client to ensure that the value is unique across different requests. The client token supports 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 instance ID of the VPN gateway.	vpn-bp1a3kqjiiq9legfx****
RouteSource	string	Yes	The source CIDR block of the policy-based route.	192.168.1.0/24
RouteDest	string	Yes	The destination CIDR block of the policy-based route.	10.0.0.0/24
NextHop	string	Yes	The next hop of the policy-based route.	vco-bp15oes1py4i66rmd****
Weight	integer	Yes	The original weight of the policy-based route. Valid values: 100: The IPsec-VPN connection associated with the current policy-based route is the active link. 0: The IPsec-VPN connection associated with the current policy-based route is the standby link.	0
NewWeight	integer	Yes	The new weight of the policy-based route. Valid values: 100: The IPsec-VPN connection associated with the current policy-based route is the active link. 0: The IPsec-VPN connection associated with the current policy-based route is the standby link.	100
OverlayMode	string	No	The tunnel protocol. Valid value: Ipsec (IPsec tunnel protocol).	Ipsec
Priority	integer	No	Policy priority of the policy-based route. If the policy-based route does not have a priority, you do not need to specify this parameter. If the policy-based route has a priority, you can specify or leave this parameter empty. If you specify this parameter, you must set it to policy priority that is already configured for the policy-based route. If you set it to another value, the call to this operation fails.	10

Response elements

Element	Type	Description	Example
	object	The response.
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.SrcDestWeightConflict	The VPN gateway does not support Policy-based routing with the same source CIDR, destination CIDR and weight.	VPN Gateway does not support policy-based routes that have the same source CIDR block, destination CIDR block, and weight.
400	VpnRouteEntry.SamePriorityPbrRoutePrefixOverlap	The source CIDR and destination CIDR of Policy-based routes with the same priority cannot overlap.	VPN Gateway does not support policy-based routes that have the same priority and overlapping source CIDR blocks and destination CIDR blocks.
400	VpnRouteEntry.SrcDestConflict	The VPN gateway does not support Policy-based routing with the same source CIDR and destination CIDR.	The source CIDR block and destination CIDR block of a policy-based route for a dual-tunnel VPN gateway cannot be the same.
400	VpnPbrRouteEntry.NotSupport	Current version of the VPN does not support pbr route entry.	Current version of the VPN does not support pbr route entry.
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.
404	InvalidPbrRouteEntry.NotFound	The specified PBR route entry does not exist.	The specified PBR route does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.