Modifies the weight of a destination-based route of a VPN gateway.
Usage notes
- The ModifyVpnRouteEntryWeight operation is asynchronous. After you send a request, the system returns a request
ID, but the operation is still being performed in the system background. You can call
DescribeVpnGateway to query the status of a VPN gateway.
- 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
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ModifyVpnRouteEntryWeight |
The operation that you want to perform. Set the value to ModifyVpnRouteEntryWeight. |
RegionId | String | Yes | cn-hangzhou |
The ID of the region where the VPN gateway is created. You can call the DescribeRegions operation to query the most recent region list. |
ClientToken | String | No | d7d24a21-f4ba-4454-9173-b3828dae492b |
The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The client token can contain only ASCII characters. Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId of each API request may be different.
|
VpnGatewayId | String | Yes | vpn-bp1a3kqjiiq9legfx**** |
The ID of the VPN gateway. |
RouteDest | String | Yes | 10.0.0.0/24 |
The destination CIDR block of the destination-based route. |
NextHop | String | Yes | vco-bp15oes1py4i66rmd**** |
The next hop of the destination-based route. |
Weight | Integer | Yes | 0 |
The previous weight of the destination-based route. Valid values:
|
NewWeight | Integer | Yes | 100 |
The new weight that you want to set for the destination-based route. Valid values:
|
OverlayMode | String | No | Ipsec |
The tunneling protocol. Set the value to Ipsec. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 5BE01CD7-5A50-472D-AC14-CA181C5C03BE |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=ModifyVpnRouteEntryWeight
&NewWeight=100
&NextHop=vco-bp15oes1py4i66rmd****
&RegionId=cn-hangzhou
&RouteDest=10.0.0.0/24
&VpnGatewayId=vpn-bp1a3kqjiiq9legfx****
&Weight=0
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyVpnRouteEntryWeightResponse>
<RequestId>5BE01CD7-5A50-472D-AC14-CA181C5C03BE</RequestId>
</ModifyVpnRouteEntryWeightResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "E82612A9-CB90-4D7E-B394-1DB7F6509B29"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | Resource.QuotaFull | The quota of resource is full | The error message returned because the resource quota is reached. |
400 | VpnGateway.Configuring | The specified service is configuring. | The error message returned because the operation is not allowed when the specified service is being configured. Try again later. |
400 | VpnGateway.FinancialLocked | The specified service is financial locked. | The error message returned because the service is suspended due to overdue payments. Top up your account first. |
400 | VpnRouteEntry.Conflict | The specified route entry has conflict. | The error message returned because the specified route conflicts with an existing route. |
403 | Forbbiden.SubUser | User not authorized to operate on the specified resource as your account is created by another user. | The error message returned because 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. | The error message returned because you are unauthorized to perform this operation on the specified resource. You can apply for the required permissions and try again. |
404 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id does not exist. | The error message returned because the specified VPN gateway does not exist. Check whether the specified VPN gateway is valid. |
For a list of error codes, visit the Error Center.