調用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 |
| SupportMulticast | boolean | 否 | 是否開啟企業版轉發路由器的組播功能。取值：
僅部分地域的企業版轉發路由器支持組播功能，您可以調用 ListTransitRouterAvailableResource 接口查詢支持組播功能的地域信息。 | false |
| TransitRouterCidrList | array<object> | 否 | 轉發路由器地址段列表。 | |
| object | 否 | |||
| Cidr | string | 否 | 轉發路由器地址段。 | 192.168.10.0/24 |
| Name | string | 否 | 轉發路由器地址段的名稱。 名稱長度為 1~128 個字符。 | nametest |
| Description | string | 否 | 轉發路由器地址段的描述信息。 描述長度為 1~256 個字符。 | desctest |
| PublishCidrRoute | boolean | 否 | 是否允許系統自動在轉發路由器路由表中添加轉發路由器地址段的路由。
| true |
| Tag | array<object> | 否 | 標簽信息。 | |
| object | 否 | 標簽信息。 一次最多支持輸入 20 個標簽信息。 | ||
| Key | string | 否 | 資源的標簽鍵。 一旦傳入該值，則不允許為空字符串。最多支持 64 個字符，不能以 一次最多支持輸入 20 個標簽的標簽鍵。 | tagtest |
| Value | string | 否 | 資源的標簽值。 標簽值可以為空或輸入不超過 128 個字符的字符串，不能以 每一個標簽鍵對應一個標簽值，一次最多支持輸入 20 個標簽鍵對應的標簽值。 | TagValue |
返回參數
示例
正常返回示例
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. | 參數中指定的Region不合法。 |
| 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. | 賬號無權限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-10-28 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-07-10 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-10-20 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-01-03 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2022-12-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |