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 applies only to VPN gateway instances that support IPsec-VPN connections in single-tunnel mode. For VPN gateway instances that support IPsec-VPN connections in dual-tunnel mode, the weight does not take effect even if this operation is called successfully.

If active/standby policy-based routes exist on a VPN gateway instance and you want to modify the weight of the active policy-based route, delete the standby policy-based route first, modify the active policy-based route, and then reconfigure the standby policy-based route. If you want to modify the weight of the standby policy-based route, delete the active policy-based route first, modify the standby policy-based route, and then reconfigure the active policy-based route. To delete a policy-based route, invoke DeleteVpnPbrRouteEntry.
ModifyVpnPbrRouteEntryWeight is an asynchronous operation. After a request is sent, the system returns a request ID and runs the node in the background. You can invoke DescribeVpnGateway to query the instance status of the VPN gateway to 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.
ModifyVpnPbrRouteEntryWeight does not support concurrent modifications of policy-based routes on 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 DescribeRegions to query the most recent region list.	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 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 RequestId value as the ClientToken value. The RequestId of each API request is different.	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 policy-based route serves as the active connection. 0: The IPsec-VPN connection associated with the policy-based route serves as the standby connection.	0
NewWeight	integer	Yes	The new weight of the policy-based route. Valid values: 100: The IPsec-VPN connection associated with the policy-based route serves as the active connection. 0: The IPsec-VPN connection associated with the policy-based route serves as the standby connection.	100
OverlayMode	string	No	The tunneling protocol. Set the value to Ipsec (IPsec tunneling protocol).	Ipsec
Priority	integer	No	Policy priority of the policy-based route. If no priority was previously configured for the policy-based route, you do not need to specify this parameter. If a priority was previously configured for the policy-based route, you can specify or skip this parameter. If you specify this parameter, enter policy priority that was previously configured for the policy-based route. If you enter a different value, the operation fails.	10

Response elements

Element	Type	Description	Example
	object	The response parameters.
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.