調用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} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 |
返回參數
示例
正常返回示例
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. | 指定的 VPN 網關不存在，請您檢查 VPN 網關是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-08-02 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |