CreateVpnRouteEntry - VPN Gateway

呼叫CreateVpnRouteEntry介面為VPN閘道器執行個體建立目的路由，建立目的路由後，VPN閘道器執行個體將基於流量的目的IP位址匹配目的路由，然後根據流量匹配到的目的路由轉發流量。

介面說明

前提條件

建立目的路由前，請確保您已經建立了 IPsec 連線。具體操作，請參見 CreateVpnConnection 。
建立目的路由前，建議您先了解目的路由的匹配原則。更多資訊，請參見配置目的路由。

使用限制

不支援 0.0.0.0/0 作為目的路由的目標網段。
針對單隧道 VPN 閘道器，不支援與 100.64.0.0/10 存在位址重疊的網段（包括其本身、子網段及包含它的父網段）作為目的路由的目標網段。
CreateVpnRouteEntry 介面屬於非同步介面，即系統先返回目的路由配置資訊，但該目的路由尚未建立成功，系統後台的建立任務仍在進行。您可以呼叫 DescribeVpnGateway 查詢目的路由的建立狀態：
- 當 VPN 閘道器執行個體處於 updating 狀態時，表示目的路由正在建立中。
- 當 VPN 閘道器執行個體處於 active 狀態時，表示目的路由建立成功。
CreateVpnRouteEntry 介面不支援在同一 VPN 閘道器下並行建立目的路由。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:CreateVpnRouteEntry

create

*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-b3828dae****
VpnGatewayId	string	是	VPN 閘道器執行個體 ID。	vpn-bp1a3kqjiiq9legfx****
RouteDest	string	是	目的路由的目標網段。	10.0.0.0/24
NextHop	string	是	目的路由的下一跳。	vco-bp15oes1py4i66rmd****
Weight	integer	是	目的路由的權重值。在您使用同一個 VPN 閘道器執行個體搭建主備 IPsec-VPN 連線的場景中，您可以透過配置目的路由的權重值來指定主鏈路和備鏈路，權重值為 100 的目的路由預設為主鏈路，權重值為 0 的目的路由預設為備鏈路。您可以透過為 IPsec 連線配置健康檢查來自動偵測鏈路的連通性，在主鏈路不通的情況下，系統自動將流量切換至備鏈路進行傳輸，實現上雲端鏈路的高可用性。具體操作，請參見 CreateVpnConnection 。 100：表示目前目的路由關聯的 IPsec 連線為主鏈路。 0：表示目前目的路由關聯的 IPsec 連線為備鏈路。說明指定主備鏈路時，主目的路由和備目的路由的目標網段需相同，下一跳需不同，權重值也需不同。對於支援雙隧道模式 IPsec-VPN 連線的 VPN 閘道器執行個體，無需配置該參數。一個雙隧道模式 IPsec-VPN 連線包含兩條隧道，兩條隧道自動形成主備鏈路，無需再透過配置該參數指定主備鏈路。如果您配置了該參數，則該參數配置後不生效。	0
PublishVpc	boolean	是	是否發佈目的路由到 VPC 中。取值： true：發佈目的路由到 VPC 中。系統僅會將路由發佈至 VPC 系統路由表中，而不會發佈至 VPC 自訂路由表中。如果 VPC 自訂路由表中需要包含該路由，請您手動新增。具體操作，請參見 CreateRouteEntry 。 false：不發佈目的路由到 VPC 中。您需要在 VPC 系統路由表和自訂路由表中手動新增下一跳指向 VPN 閘道器執行個體的目的路由，否則 VPC 將無法透過 IPsec-VPN 連線存取該網段下的資源。	true
Description	string	否	目的路由的描述資訊。描述資訊長度為 1～100 個字元，不能以`http://`或`https://`開頭。	mytest
OverlayMode	string	否	隧道協定。僅取值：Ipsec（IPsec 隧道協定）。	Ipsec
DryRun	boolean	否	是否僅預檢此次請求。取值： true：傳送檢查請求，不會建立路由。檢查項目包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼`DryRunOperation`。 false（預設值）：傳送正常請求，通過檢查後返回 HTTP 2xx 狀態碼並直接進行操作。	false

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
NextHop	string	目的路由的下一跳。	vco-bp15oes1py4i66rmd****
Weight	integer	目的路由的權重值。取值： 100：表示目的路由的優先順序較高。 0：表示目的路由的優先順序較低。	0
RouteDest	string	目的路由的目標網段。	10.0.0.0/24
RequestId	string	請求 ID。	5BE01CD7-5A50-472D-AC14-CA181C5C03BE
Description	string	目的路由的描述資訊。	mytest
State	string	目的路由的發佈狀態。 published：已發佈目的路由到 VPC 的路由表。 normal：未發佈目的路由到 VPC 的路由表。	published
CreateTime	integer	建立目的路由的時間戳記。單位：毫秒。時間戳記的格式採用 Unix 時間戳記，表示從格林威治時間 1970 年 01 月 01 日 00 時 00 分 00 秒至建立目的路由時的總時長。	1492747187000
OverlayMode	string	隧道協定。僅取值：Ipsec（IPsec 隧道協定）。	Ipsec
VpnInstanceId	string	VPN 閘道器執行個體 ID。	vpn-bp1a3kqjiiq9legfx****

樣本

正常返回樣本

JSON格式

{
  "NextHop": "vco-bp15oes1py4i66rmd****",
  "Weight": 0,
  "RouteDest": "10.0.0.0/24",
  "RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE",
  "Description": "mytest",
  "State": "published",
  "CreateTime": 1492747187000,
  "OverlayMode": "Ipsec",
  "VpnInstanceId": "vpn-bp1a3kqjiiq9legfx****"
}

錯誤碼

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.ConflictSSL	The specified route entry has conflict with SSL client.	路由項目與SSL用戶端衝突。
400	VpnRouteEntry.BackupRoute	Validate backup route entry failed.	主備路由條目校驗失敗。
400	VpnRouteEntry.InvalidWeight	Invalid route entry weight value.	路由權重值不合法。
400	InvalidNextHop.NotFound	The specified NextHop does not exist.	該下一跳位址不存在。
400	IllegalParam.RouteDest	The specified RouteDest is invalid	目的位址不合法。
400	OperationFailed.RouteConflict	Operation failed because there is already a route in VPC route table to another VPN on the same network block.	指定的首碼清單中的網段與IPsec連線中已有的路由項目衝突，請消除衝突後重試。
400	OperationFailed.InvalidCidrBlock	Operation failed because the specified network block is invalid.	網段不合法。
400	QuotaExceeded.VpnRouteEntry	The number of route entries to the VPN gateway in the VPC routing table has reached the quota limit.	VPC路由表中指向VPN閘道器的路由條目已經達到配額限制。
400	TaskConflict	The operation is too frequent, please wait a moment and try again.	EIP操作太頻繁。
400	VpnTask.CONFLICT	Vpn task has conflict.	VPN 操作存在衝突，請稍後重試。
400	IncorrectVpcStatus	Current VPC status does not support this operation.
400	InternalError	The request processing has failed due to some unknown error, exception or failure.
400	InvalidCidrBlock.Malformed	Specified CIDR block is not valid.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	DryRun 驗證通過。
400	CreatePbrRoutesQuotaFull.QuotaFull	The number of policy routes exceeds the quota limit.	策略路由數量超過配額限制。
400	CreateDbrRoutesQuotaFull.QuotaFull	The number of created destination routes exceeds the quota limit.	建立目的路由數量超過配額限制。
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.

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

變更歷史

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