使用CreateTransitRouter介面建立企業版轉寄路由器執行個體-雲企業網-阿里雲 - Cloud Enterprise Network

呼叫 CreateTransitRouter 介面建立企業版轉發路由器執行個體。

介面說明

您可以透過呼叫 CreateTransitRouter 介面建立企業版轉發路由器執行個體。目前企業版轉發路由器僅在部分地域開放，關於地域的詳細資訊，請參閱什麼是雲企業網。
CreateTransitRouter 介面屬於非同步介面，即系統會先返回一個企業版轉發路由器執行個體 ID，但該企業版轉發路由器執行個體並未建立完成，系統後台的建立任務仍在進行。您可以呼叫 ListTransitRouters 介面查詢企業版轉發路由器執行個體的狀態。
- 當企業版轉發路由器執行個體處於 Creating 狀態時，表示企業版轉發路由器執行個體正在建立中，在該狀態下，您只能對企業版轉發路由器執行個體執行查詢操作，不能執行其他操作。
- 當企業版轉發路由器執行個體處於 Active 狀態時，表示企業版轉發路由器執行個體建立完成。
在一個雲企業網執行個體中，一個地域僅支援建立一個轉發路由器執行個體。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cen:CreateTransitRouter

create

CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

TransitRouter

acs:cen:*:{#accountId}:centransitrouter/*

無

請求參數

名稱	類型	必填	描述	樣本值
ClientToken	string	否	用戶端 Token，用於保證請求的冪等性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 識別碼。每次 API 請求的 RequestId 不一樣。	02fb3da4-130e-11e9-8e44-001****
CenId	string	是	雲企業網執行個體 ID。	cen-j3jzhw1zpau2km****
RegionId	string	是	企業版轉發路由器執行個體所屬地域 ID。您可以透過呼叫 DescribeChildInstanceRegions 介面取得地域 ID。	cn-zhangjiakou
TransitRouterName	string	否	企業版轉發路由器執行個體的名稱。名稱可以為空或長度為 1～128 個字元，不能以 http:// 或 https:// 開頭。	testname
TransitRouterDescription	string	否	企業版轉發路由器執行個體的描述。描述可以為空或長度為 1～256 個字元，不能以 http:// 或 https:// 開頭。	testdesc
DryRun	boolean	否	是否對此次建立請求執行預檢，包括權限、執行個體狀態驗證等。取值： false（預設值）：傳送正常請求，通過檢查後直接建立企業版轉發路由器執行個體。 true：傳送檢查請求，只進行驗證，不會建立企業版轉發路由器執行個體。檢查項目包括是否填寫了必要參數、請求格式等。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼 `DryRunOperation`。	false
SupportMulticast	boolean	否	是否開啟企業版轉發路由器的群播功能。取值： false（預設值）：不開啟。 true：開啟。僅部分地域的企業版轉發路由器支援群播功能，您可以呼叫 ListTransitRouterAvailableResource 介面查詢支援群播功能的地域資訊。	false
TransitRouterCidrList	array<object>	否	轉發路由器位址區段清單。
	object	否	轉發路由器位址區段清單。一次最多支援新增 5 個轉發路由器位址區段。關於轉發路由器位址區段的更多資訊，請參閱轉發路由器位址區段。說明僅企業版轉發路由器支援新增位址區段。
Cidr	string	否	轉發路由器位址區段。	192.168.10.0/24
Name	string	否	轉發路由器位址區段的名稱。名稱長度為 1~128 個字元。	nametest
Description	string	否	轉發路由器位址區段的描述資訊。描述長度為 1~256 個字元。	desctest
PublishCidrRoute	boolean	否	是否允許系統自動在轉發路由器路由表中新增轉發路由器位址區段的路由。 true（預設值）：允許。如果您選擇了允許，則在您建立了私網閘道器類型的 VPN 連線，並為私網閘道器類型的 VPN 連線建立了路由學習關係後，系統自動在與 VPN 連線建立路由學習關係的轉發路由器路由表中新增一條路由項目：目標網段為轉發路由器位址區段的黑洞路由，其中轉發路由器位址區段指已為 IPsec 連線分配閘道器 IP 位址的位址區段。該黑洞路由僅會被傳播至轉發路由器下邊界路由器 VBR（Virtual Border Router）執行個體的路由表中。 false：不允許。	true
Tag	array<object>	否	標籤資訊。
	object	否	標籤資訊。一次最多支援輸入 20 個標籤資訊。
Key	string	否	資源的標籤鍵。一旦傳入該值，則不允許為空字串。最多支援 64 個字元，不能以 `aliyun` 或者 `acs:` 開頭，不能包含 `http://` 或者 `https://` 。一次最多支援輸入 20 個標籤的標籤鍵。	tagtest
Value	string	否	資源的標籤值。標籤值可以為空或輸入不超過 128 個字元的字串，不能以 `aliyun` 或者 `acs:` 開頭，不能包含 `http://` 或者 `https://` 。每一個標籤鍵對應一個標籤值，一次最多支援輸入 20 個標籤鍵對應的標籤值。	TagValue

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
TransitRouterId	string	企業版轉發路由器執行個體 ID。	tr-uf6llz2286805i44g****
RequestId	string	請求 ID。	404DA7EC-F495-44B5-B543-6EDCDF90F3D1

樣本

正常返回樣本

JSON格式

{
  "TransitRouterId": "tr-uf6llz2286805i44g****",
  "RequestId": "404DA7EC-F495-44B5-B543-6EDCDF90F3D1"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	OperationUnsupported.RegionId	The specified Region is not supported.	目前區域不支援此操作。
400	InstanceExist.TransitRouterInstance	The instance already exists.	目前 Region 下的 TransitRouter 執行個體已存在，不允許在同一個 Region 下重複建立。
400	Forbbiden.TransitRouterServiceNotOpen	The user has not open transit router service.	轉發路由器服務未開啟，請開啟後重試。
400	OperationUnsupported.SupportMulticast	The multicast is not supported in the specified region.	目前地域不支援群播。
400	OperationUnsupported.CenFullLevel	CEN full level does not support TransitRouter.
400	IllegalParam.Cidr	Cidr is illegal.	參數中指定的 cidr 不合法。
400	Illegal.TrType	The TransitRouter type is illegal.	轉發路由器類型不支援該操作。
400	OperationUnsupported.TransitRouterCidrList	The TransitRouterCidrList is not support in the specified Region.	目前區域不支援此操作。
400	OperationFailed.CidrConflict	Operation is invalid because the cidr conflict.	CIDR 衝突。
400	IllegalParam.Region	The specified region is invalid.
400	OverLappingExist.Cidr	The cidr overlapping exist.	cidr overlapping 已存在。
400	IllegalParam.ServiceMode	The specified ServiceMode is invalid.	參數中指定的 ServiceMode 不合法。
400	ParamExclusive.ServiceModeAndSupportMulticast	ServiceMode and SupportMulticast is mutually exclusive.	該模式的轉發路由器不支援開啟群播功能。
400	ParamExclusive.ServiceModeAndTransitRouterCidrList	ServiceMode and TransitRouterCidrList is mutually exclusive.	該模式的轉發路由器不支援開啟 CIDR 功能。
400	OperationUnsupported.Tag	The Tag is not supported in the specified region.	該地域不支援轉發路由器 Tag 功能。
400	IllegalParam.SupportMulticast	Basic Transit router is not support multicast.	基礎版轉發路由器不支援多播功能。
400	ParamExclusive.BasicAndPrimaryStandby	Basic and PrimaryStandby is mutually exclusive.	基礎版轉發路由器不支援設定模式為 PrimaryStandby。
400	ParamExclusive.BasicAndMultiPrimary	Basic and MultiPrimary is mutually exclusive.	基礎版轉發路由器不支援設定模式為 MultiPrimary。
400	IllegalParam.RegionId	The Specified Parameter RegionId is illegal.	參數中指定的 Region 無效。
400	OperationFailed.PostPay95BwpNotAllowEnterpriseTr	Cbn with post pay 95 bandwidth package does not allow enterprise tr.	使用舊版 95 頻寬包的雲企業網不允許建立企業版轉發路由器。
400	Forbidden.TransitRouterServiceExpired	The transit router service is out of service.	轉發路由器服務已欠費停服，請續費後重試。
400	InvalidParameter	Invalid parameter.	參數不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	帳號無權限操作。
400	IllegalParam.TagValue	The tag values are not valid.	參數中指定的 tag value 不合法。
400	IllegalParam.TagKey	The tag keys are not valid.	參數中指定的 tag key 不合法。
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	輸入的參數 Tag Value 不合法。

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

變更歷史

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