调用ModifyVpnRouteEntryWeight接口修改目的路由的权重值。
接口说明
本接口仅适用于支持单隧道模式 IPsec-VPN 连接的 VPN 网关实例。对于支持双隧道模式 IPsec-VPN 连接的 VPN 网关实例,调用本接口成功修改权重值后,权重值也不会生效。
在 VPN 网关实例下存在主备目的路由场景下,如果您需要修改主目的路由的权重值,需先将备目的路由删除,待主目的路由修改完成后,再重新配置备目的路由。如果您需要修改备目的路由的权重值,也需先删除主目的路由,待备目的路由修改完成后再重新配置主目的路由。删除目的路由,请参见 DeleteVpnRouteEntry 。
- ModifyVpnRouteEntryWeight 接口属于异步接口,即系统先返回一个请求 ID,但该 VPN 目的路由的权重值尚未修改成功,系统后台的修改任务仍在进行。您可以调用 DescribeVpnGateway 查询 VPN 目的路由的权重值的修改状态:
当 VPN 目的路由处于 updating 状态时,表示 VPN 目的路由的权重值正在修改中。
当 VPN 目的路由处于 active 状态时,表示 VPN 目的路由的权重值修改成功。
ModifyVpnRouteEntryWeight 接口不支持在同一 VPN 网关下并发修改目的路由的权重值。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
VPN 网关实例所属地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。 |
cn-hangzhou |
| ClientToken |
string |
否 |
客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。 |
d7d24a21-f4ba-4454-9173-b3828dae492b |
| VpnGatewayId |
string |
是 |
VPN 网关的 ID。 |
vpn-bp1a3kqjiiq9legfx**** |
| RouteDest |
string |
是 |
目的路由的目标网段。 |
10.0.0.0/24 |
| NextHop |
string |
是 |
目的路由的下一跳。 |
vco-bp15oes1py4i66rmd**** |
| Weight |
integer |
是 |
目的路由在修改之前设置的权重值,取值:
|
0 |
| NewWeight |
integer |
是 |
目的路由新的权重值,取值:
|
100 |
| OverlayMode |
string |
否 |
隧道协议,取值:Ipsec(IPsec 隧道协议)。 |
Ipsec |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
5BE01CD7-5A50-472D-AC14-CA181C5C03BE |
示例
正常返回示例
JSON格式
{
"RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE\t"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 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. | 该路由已存在。 |
| 400 | VpnRouteEntry.Conflict | The specified route entry has conflict. | 路由条目存在冲突。 |
| 400 | VpnRouteEntry.BackupRoute | Validate backup route entry failed. | 主备路由条目校验失败。 |
| 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. | 您没有权限操作指定资源,请申请权限后再操作。 |
| 404 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id does not exist. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。