CreateRouteEntries - Virtual Private Cloud

在 VPC 路由器的路由表中批次新增自訂路由條目。

介面說明

CreateRouteEntries 介面屬於非同步介面，即系統會返回一個執行個體 ID，但該路由的建立尚未完成，系統背景的啟動任務仍在進行。您可以呼叫 DescribeRouteEntryList 查詢路由的建立狀態：
- 當路由處於 Creating 狀態時，表示路由建立中。
- 當路由處於 Created 狀態時，表示路由建立完成。
CreateRouteEntries 介面不支援在同一個 VPC 中並行批次建立自訂路由條目。

使用該介面為 VPC 路由器的路由表新增自訂路由條目時，請注意以下事項：

同一個路由表中自訂路由條目不能超過 200 條。
自訂路由條目的目標網段（DstCidrBlock）不能和 VPC 內的交換器的網段相同，也不能包含交換器的網段或者被交換器的網段包含。
自訂路由條目的目標網段（DstCidrBlock）不能指向 100.64.0.0/10，也不能被 100.64.0.0/10 包含。
同一路由表下的路由條目的目標網段（DstCidrBlock）不允許相同。
如果指定的目標網段（DstCidrBlock）是一個 IP 位址，會按照 32 位元遮罩來處理。
多條自訂路由條目可以指向同一個下一跳（NextHop）。
自訂路由條目的下一跳（NextHop）必須和路由表在同一個 VPC。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:CreateRouteEntries

create

*RouteEntry

acs:vpc:{#regionId}:{#accountId}:routetable/{#RouteTableId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	路由表所屬地域的 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。	cn-hangzhou
RouteEntries	array<object>	是	路由條目資訊清單。
	object	否	路由條目資訊清單。
DstCidrBlock	string	是	自訂路由條目的目標網段，支援 IPv4 和 IPv6 的目標網段。最多支援輸入 50 個目標網段。需滿足以下要求：目標網段不能指向 100.64.0.0/10 或被 100.64.0.0/10 包含。同一張路由表內的不同路由條目的目標網段不能相同。	192.168.0.0/24
RouteTableId	string	是	要新增自訂路由條目的路由表 ID。最多支援輸入 50 個路由表 ID。	vtb-bp145q7glnuzd****
IpVersion	integer	否	IP 協定的版本。最多支援輸入 50 個 IP 協定的版本。取值： 4：IPv4 協定。 6：IPv6 協定。	4
NextHop	string	是	自訂路由條目的下一跳執行個體的 ID。最多支援輸入 50 個執行個體 ID。說明若選擇 NextHopType 為 ECR，您可以透過 DescribeExpressConnectRouterAssociation 介面取得 AssociationId 作為下一跳 ID。	i-j6c2fp57q8rr4jlu****
NextHopType	string	是	自訂路由條目的下一跳的類型。最多支援輸入 50 個下一跳類型。取值： Instance（預設值）：ECS 執行個體。 HaVip：高可用虛擬 IP。 RouterInterface：路由器介面。 NetworkInterface：彈性網卡。 VpnGateway：VPN 閘道器。 IPv6Gateway：IPv6 閘道器。 NatGateway：NAT 閘道器。 Attachment：轉送路由器。 VpcPeer：VPC 對等連線。 Ipv4Gateway：IPv4 閘道器。 GatewayEndpoint：閘道器終端節點。 CenBasic：CEN 不支援轉送路由器。 Ecr：專線閘道器。 GatewayLoadBalancerEndpoint：閘道器型負載平衡終端節點。 RouteTargetGroup：路由目標群組。	RouterInterface
Name	string	否	要新增的自訂路由條目的名稱。最多支援輸入 50 個名稱。名稱長度為 1～128 個字元，不能以 `http://` 或 `https://` 開頭。	test
Description	string	否	自訂路由條目的描述資訊。最多支援輸入 50 個描述。描述長度為 1～256 個字元，不能以 `http://` 或 `https://` 開頭。	test
DryRun	boolean	否	是否僅預檢此次請求，取值： true：發送請求，不會建立路由條目。檢查項目包括 AccessKey 是否有效、RAM 使用者的授權情況和是否填寫了必要參數。如果檢查未通過，則返回對應錯誤。如果檢查通過，會返回錯誤碼 `DryRunOperation`。 false（預設值）：發送正常請求，通過檢查後返回 2xx HTTP 狀態碼並直接建立路由條目。

返回參數

名稱	類型	描述	樣本值
	object	成功任務數。
SuccessCount	integer	新增成功的路由條目數。	2
FailedCount	integer	新增失敗的路由條目數。	2
RequestId	string	請求 ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
FailedRouteEntries	array<object>	新增失敗的路由條目數的詳細資訊。
	object	新增失敗的路由條目數的詳細資訊。
DstCidrBlock	string	新增失敗的自訂路由條目的目標網段。	192.168.0.0/24
NextHop	string	新增失敗的自訂路由條目的下一跳執行個體的 ID。	i-j6c2fp57q8rr4jlu****
FailedCode	string	失敗的錯誤碼。	VPC_ROUTE_ENTRY_CIDR_BLOCK_DUPLICATE
FailedMessage	string	失敗的具體報錯資訊。	Specified CIDR block is already exists, entry.cidrBlock=xxxx
RouteEntryIds	array	新增成功的自訂路由條目返回的執行個體 ID 資訊。
	string	新增成功的自訂路由條目返回的執行個體 ID。	rte-sn6vjkioxte1gz83z****

樣本

正常返回樣本

JSON格式

{
  "SuccessCount": 2,
  "FailedCount": 2,
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "FailedRouteEntries": [
    {
      "DstCidrBlock": "192.168.0.0/24",
      "NextHop": "i-j6c2fp57q8rr4jlu****",
      "FailedCode": "VPC_ROUTE_ENTRY_CIDR_BLOCK_DUPLICATE",
      "FailedMessage": "Specified CIDR block is already exists, entry.cidrBlock=xxxx"
    }
  ],
  "RouteEntryIds": [
    "rte-sn6vjkioxte1gz83z****"
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	DryRunOperation	Request validation has been passed with DryRun flag set.	DryRun 驗證通過。
400	InvalidCIDRBlock.Duplicate	Specified CIDR block is already exists.
400	MissingParam.RouteTableId	The parameter RouteTableId is missing.

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

變更歷史

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