Modifies the weight of a destination-based route for a VPN gateway.
Operation description
-
If a VPN gateway has both an active and a standby destination-based route, you must delete one before modifying the other. For example, to modify the active route weight, delete the standby route first, modify the active route, and then reconfigure the standby route. The same applies in reverse. For more information, 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. Call DescribeVpnGateway to query the task status.
-
If the VPN gateway is in the updating state, the route weight is being modified.
-
If the VPN gateway is in the active state, the route weight has been modified.
-
-
You cannot repeatedly call ModifyVpnRouteEntryWeight to modify the weight of a destination-based route for the same VPN gateway within a specified period of time.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID of the VPN gateway. 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 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 |
| NewWeight |
integer |
Yes |
The new weight of the destination-based route. Valid values:
|
100 |
| OverlayMode |
string |
No |
The tunneling protocol. Set the value to Ipsec. |
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.