ModifyVpnRouteEntryWeight - 修改目的路由的权重值

调用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代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:ModifyVpnRouteEntryWeight
  • VpnGateway
    acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

请求参数

名称类型必填描述示例值
RegionIdstring

VPN 网关实例所属地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
d7d24a21-f4ba-4454-9173-b3828dae492b
VpnGatewayIdstring

VPN 网关的 ID。

vpn-bp1a3kqjiiq9legfx****
RouteDeststring

目的路由的目标网段。

10.0.0.0/24
NextHopstring

目的路由的下一跳。

vco-bp15oes1py4i66rmd****
Weightinteger

目的路由在修改之前设置的权重值,取值:

  • 0:低优先级。

  • 100:高优先级。

0
NewWeightinteger

目的路由新的权重值,取值:

  • 0:低优先级。

  • 100:高优先级。

100
OverlayModestring

隧道协议,取值:Ipsec(IPsec 隧道协议)。

Ipsec

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

5BE01CD7-5A50-472D-AC14-CA181C5C03BE

示例

正常返回示例

JSON格式

{
  "RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE\t"
}

错误码

HTTP status code错误码错误信息描述
400Resource.QuotaFullThe quota of resource is full资源配额已达上限。
400VpnGateway.ConfiguringThe specified service is configuring.服务正在配置中,请您稍后再试。
400VpnGateway.FinancialLockedThe specified service is financial locked.该服务已欠费,请您先充值再操作。
400VpnRouteEntry.AlreadyExistsThe specified route entry is already exist.该路由已存在。
400VpnRouteEntry.ConflictThe specified route entry has conflict.路由条目存在冲突。
400VpnRouteEntry.BackupRouteValidate backup route entry failed.主备路由条目校验失败。
403Forbbiden.SubUserUser not authorized to operate on the specified resource as your account is created by another user.您没有权限操作该资源,请您申请操作权限后再试。
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。
404InvalidVpnGatewayInstanceId.NotFoundThe specified vpn gateway instance id does not exist.指定的 VPN 网关不存在,请您检查 VPN 网关是否正确。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-08-02OpenAPI 错误码发生变更查看变更详情