ModifyVpnRouteEntryWeight - VPN Gateway

Modifies the weight of a destination-based route.

Operation description

In scenarios where a VPN gateway has an active and a standby destination-based route, if you need to modify the weight of the active destination-based route, you must first delete the standby destination-based route. After you modify the active destination-based route, configure a standby destination-based route. If you need to modify the weight of the standby destination-based route, you also need to delete the active destination-based route first. After you modify the standby destination-based route, configure an active destination-based route. For more information about how to delete a destination-based route, see DeleteVpnRouteEntry .
ModifyVpnRouteEntryWeight 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 the VPN gateway is in the updating state, the weight of the destination-based route is being modified.
- If the VPN gateway is in the active state, the weight of the destination-based route is modified.
You cannot repeatedly call the ModifyVpnRouteEntryWeight operation to modify the weight of destination-based route for the same VPN gateway within the specified period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:ModifyVpnRouteEntryWeight		VpnGateway acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	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
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 request ID as the client token. The request ID may be different for each request.	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-based route.	10.0.0.0/24
NextHop	string	Yes	The next hop of the destination-based route.	vco-bp15oes1py4i66rmd****
Weight	integer	Yes	The original weight of the destination-based route. Valid values: 0: a low priority 100: a high priority	0
NewWeight	integer	Yes	The new weight of the destination-based route. Valid values: 0: a low priority 100: a high priority	100
OverlayMode	string	No	The tunneling protocol. Set the value to Ipsec.	Ipsec

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	5BE01CD7-5A50-472D-AC14-CA181C5C03BE

Examples

Sample success responses

JSONformat

{
  "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	The resource quota is exhausted.
400	VpnGateway.Configuring	The specified service is configuring.	The service is being configured. Try again later.
400	VpnGateway.FinancialLocked	The specified service is financial locked.	The service is suspended due to overdue payments. Top up your account first.
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.	You are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again.
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.	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.

Change history

Change time	Summary of changes	Operation
2023-08-02	The Error code has changed	View Change Details