Use ModifyVpnPbrRouteEntryAttribute to modify the weight and priority of a policy-based route - VPN Gateway - Alibaba Cloud - VPN Gateway

Modifies the weight and policy priority of a policy-based route by calling the ModifyVpnPbrRouteEntryAttribute operation.

Operation description

ModifyVpnPbrRouteEntryAttribute is used to modify both the weight and policy priority of a policy-based route that supports policy priority.
- To modify only the weight of a policy-based route, call the ModifyVpnPbrRouteEntryWeight operation.
- To modify only the policy priority of a policy-based route, call the ModifyVpnPbrRouteEntryPriority operation.
- If your policy-based route does not support policy priority, you can only call the ModifyVpnPbrRouteEntryWeight operation to modify the weight of the policy-based route.
Note
For VPN gateway instances that support dual-tunnel mode IPsec-VPN connections, you can only call this operation to modify the priority of policy-based routes.
ModifyVpnPbrRouteEntryAttribute is an asynchronous operation. After you send a request, the system returns a request ID, but the policy-based route has not been modified yet. The modification node is still running in the background. You can invoke the DescribeVpnGateway operation 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 route is being modified.
- If the VPN gateway instance is in the active state, the policy-based route has been modified.
ModifyVpnPbrRouteEntryAttribute does not support concurrent modifications of policy-based routes 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:ModifyVpnPbrRouteEntryAttribute

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 the region ID.	cn-heyuan
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 ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	d7d24a21-f4ba-4454-9173-b3****
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****
Priority	integer	Yes	The original policy priority of the policy-based route. Valid values: 1 to 100. A smaller value indicates a higher priority.	5
NewPriority	integer	No	The new policy priority of the policy-based route. Valid values: 1 to 100. A smaller value indicates a higher priority. If you do not specify this parameter, the policy priority of the policy-based route is not modified. Note You must specify at least one of the NewPriority and NewWeight parameters.	10
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 link. 0: The IPsec-VPN connection associated with the policy-based route serves as the standby link.	100
NewWeight	integer	No	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 link. 0: The IPsec-VPN connection associated with the policy-based route serves as the standby link. If you do not specify this parameter, the weight of the policy-based route is not modified. Note You must specify at least one of the NewPriority and NewWeight parameters.	0

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"
}

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	VpnPbrRouteEntryPriority.NotSupport	Current version of the VPN does not support setting pbr route entry priority.	The VPN gateway version does not allow you to specify priorities for policy-based routes.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.