ModifyVpnPbrRouteEntryWeight - VPN Gateway

呼叫 ModifyVpnPbrRouteEntryWeight 介面修改 VPN 策略路由的權重值。

介面說明

說明

本介面僅適用於支援單隧道模式 IPsec-VPN 連線的 VPN 閘道器執行個體。對於支援雙隧道模式 IPsec-VPN 連線的 VPN 閘道器執行個體，呼叫本介面成功修改權重值後，權重值也不會生效。

在 VPN 閘道器執行個體下存在主備策略路由場景下，如果您需要修改主策略路由的權重值，需先將備策略路由刪除，待主策略路由修改完成後，再重新設定備策略路由。如果您需要修改備策略路由的權重值，也需先刪除主策略路由，待備策略路由修改完成後再重新設定主策略路由。刪除策略路由，請參見 DeleteVpnPbrRouteEntry 。
ModifyVpnPbrRouteEntryWeight 介面屬於非同步介面，即系統先返回一個請求 ID，但該策略路由尚未修改成功，系統背景的修改任務仍在進行。您可以呼叫 DescribeVpnGateway 介面查詢 VPN 閘道器執行個體狀態，來確定策略路由的修改狀態：
- 當 VPN 閘道器執行個體處於 updating 狀態時，表示策略路由正在修改中。
- 當 VPN 閘道器執行個體處於 active 狀態時，表示策略路由修改成功。
ModifyVpnPbrRouteEntryWeight 介面不支援在同一 VPN 閘道器執行個體下並行修改策略路由。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:ModifyVpnPbrRouteEntryWeight

update

*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****
RouteSource	string	是	策略路由的來源網段。	192.168.1.0/24
RouteDest	string	是	策略路由的目標網段。	10.0.0.0/24
NextHop	string	是	策略路由的下一跳。	vco-bp15oes1py4i66rmd****
Weight	integer	是	策略路由原始的權重值。取值： 100：表示當前策略路由關聯的 IPsec 連線為主鏈路。 0：表示當前策略路由關聯的 IPsec 連線為備鏈路。	0
NewWeight	integer	是	策略路由新的權重值。取值： 100：表示當前策略路由關聯的 IPsec 連線為主鏈路。 0：表示當前策略路由關聯的 IPsec 連線為備鏈路。	100
OverlayMode	string	否	隧道通訊協定。僅取值：Ipsec（IPsec 隧道通訊協定）。	Ipsec
Priority	integer	否	策略路由的策略優先順序。如果您的策略路由之前不存在策略優先順序，本參數可不填。如果您的策略路由之前存在策略優先順序，本參數可填，也可不填。如果您填寫了本參數，請填寫策略路由之前已設定的策略優先順序，如果您填寫為其他值，則當前介面會呼叫失敗。	10

返回參數

名稱	類型	描述	樣本值
	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.	指定的用戶端 IP 集區與 VPN 連線或 SSL 伺服器衝突。
400	VpnRouteEntry.SrcDestWeightConflict	The VPN gateway does not support Policy-based routing with the same source CIDR, destination CIDR and weight.	VPN 閘道器不支援設定來源網段、目的地網段與權重同時相同的原則路由。
400	VpnRouteEntry.SamePriorityPbrRoutePrefixOverlap	The source CIDR and destination CIDR of Policy-based routes with the same priority cannot overlap.	VPN 閘道器不支援在相同優先順序下，多個原則路由的來源與目的地網段同時重疊。
400	VpnRouteEntry.SrcDestConflict	The VPN gateway does not support Policy-based routing with the same source CIDR and destination CIDR.	雙通道類型的 VPN 閘道器不支援設定來源網段與目的地網段同時相同的原則路由。
400	VpnPbrRouteEntry.NotSupport	Current version of the VPN does not support pbr route entry.	目前 VPN 執行個體不支援原則路由。
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.	EIP 不屬於當前呼叫者，請您檢查該 EIP 是否可被您呼叫。
404	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.
404	InvalidPbrRouteEntry.NotFound	The specified PBR route entry does not exist.	指定的原則路由不存在。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。