轉發路由器支持連接VPN網關的IPsec連接。本地數據中心可以通過IPsec連接直接連接至轉發路由器，然后通過轉發路由器實現與其他網絡的互通，調用CreateTransitRouterVpnAttachment接口創建VPN連接。
接口說明
- 創建 VPN 連接后，VPN 連接默認不與任何轉發路由器路由表建立路由學習關系和關聯轉發關系。
- 在調用
CreateTransitRouterVpnAttachment接口的過程中，如果您指定了 CenId、RegionId 參數的值，則無需指定 TransitRouterId 參數的值；如果您指定了 TransitRouterId、RegionId 參數的值，則無需指定 CenId 參數的值。
前提條件
- 在創建 VPN 連接前，請確保您已經在轉發路由器實例所在的地域創建了一個 IPsec 連接，且 IPsec 連接未綁定任何資源。具體操作，請參見 CreateVpnAttachment 。
- 如果轉發路由器實例需要連接跨賬號的 IPsec 連接，則需確保 IPsec 連接已對轉發路由器實例授權。具體操作，請參見 GrantInstanceToTransitRouter 。
- 在創建 VPN 連接之前，請確保您已設置轉發路由器的 TR 地址段。具體操作，請參見 CreateTransitRouterCidr 。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| cen:CreateTransitRouterVpnAttachment | create | *CenInstance acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}*TransitRouter acs:cen:*:{#accountId}:centransitrouter/{#TransitRouterId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-42665544**** |
| DryRun | boolean | 否 | 是否只預檢此次請求。取值：
| false |
| CenId | string | 否 | 云企業網實例 ID。 | cen-rsgxs8ng2awen2**** |
| TransitRouterId | string | 否 | 轉發路由器實例 ID。 | tr-p0wm740vjnbaprv0m**** |
| RegionId | string | 否 | 轉發路由器實例所屬的地域 ID。 您可以通過調用 DescribeChildInstanceRegions 接口獲取地域 ID。 | cn-hangzhou |
| TransitRouterAttachmentName | string | 否 | VPN 連接的名稱。 名稱可以為空或長度為 1～128 個字符，不能以 http://或 https://開頭。 | nametest |
| TransitRouterAttachmentDescription | string | 否 | VPN 連接的描述信息。 描述可以為空或長度為 1～256 個字符，不能以 http://或 https://開頭。 | desctest |
| VpnId | string | 是 | IPsec 連接 ID。 | vco-p0w042cqwvlhl4zyw**** |
| VpnOwnerId | long | 否 | IPsec 連接所屬的阿里云賬號（主賬號）ID。
| 1210123456123456 |
| AutoPublishRouteEnabled | boolean | 否 | 是否允許轉發路由器實例自動向 IPsec 連接發布路由條目。取值：
| true |
| ChargeType | string | 否 | 計費方式。 僅取值：POSTPAY（默認值），表示按使用量付費。 | POSTPAY |
| Zone | array<object> | 否 | 當前地域下的可用區 ID。 系統將在您指定的可用區下創建資源。 | |
| object | 否 | 可用區 ID。 | ||
| ZoneId | string | 否 | 可用區 ID。 您可以通過調用 ListTransitRouterAvailableResource 接口獲取地域 ID。 | cn-hangzhou-h |
| Tag | array<object> | 否 | 標簽信息列表。 一次最多支持輸入 20 個標簽信息。 | |
| object | 否 | 標簽信息。 | ||
| Key | string | 否 | 資源的標簽鍵。 一旦傳入該值，則不允許為空字符串。最多支持 64 個字符，不能以 一次最多支持輸入 20 個標簽的標簽鍵。 | TagKey |
| Value | string | 否 | 資源的標簽值。 標簽值可以為空或輸入不超過 128 個字符的字符串，不能以 每一個標簽鍵對應一個標簽值，一次最多支持輸入 20 個標簽鍵對應的標簽值。 | TagValue |
返回參數
示例
正常返回示例
JSON格式
{
"TransitRouterAttachmentId": "tr-attach-y5dup2qwfyh9lu****",
"RequestId": "8B5DD40A-3A29-5AC0-B8DA-05FD10D5C893"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | NoPermission.AliyunServiceRolePolicyForCEN | You are not authorized to create the service linked role. Role Name: AliyunServiceRolePolicyForCEN. Service Name: cen.aliyuncs.com. Make sure that the user has been granted the ram:CreateServiceLinkedRole permission. | 您沒有權限創建服務關聯角色，角色名：AliyunServiceRolePolicyForCEN，服務名：cen.aliyuncs.com。請確保已授予當前用戶ram:CreateServiceLinkedRole權限。 |
| 400 | OperationUnsupported.TransitRouterRegionId | The specified TransitRouterRegion does not support the operation. | 中轉地域不支持此操作。 |
| 400 | InvalidCenId.NotFound | CenId is not found. | CEN實例不存在。 |
| 400 | InvalidStatus.ResourceStatus | The resource is not in a valid state for the attachment operation. | 當前資源狀態不支持該操作，請稍后重試。 |
| 400 | InvalidTransitRouterId.NotFound | TransitRouterId is not found. | 轉發路由實例ID不存在。 |
| 400 | Forbbiden.TransitRouterServiceNotOpen | The user has not open transit router service. | 轉發路由器服務未打開，請打開后重試。 |
| 400 | InvalidTransitRouterMode.NeedUpgrade | TransitRouter need to upgrade. | 當前轉發路由器模式不支持。 |
| 400 | InvalidAvailable.NoResource | No resource in the available zone. | 當前可用區資源不足。 |
| 400 | OperationUnsupported.VpnAttachment | The specified region does not support the operation. | 當前地域不支持該操作。 |
| 400 | OperationUnsupported.TransitRouterType | The specified TransitRouterType does not support the operation. | 當前TransitRouter類型不支持該操作。 |
| 400 | OperationFailed.AllocateCidrFailed | Operation failed because vpn allocate cidr failed. | vpn申請cidr失敗。 |
| 400 | OperationUnsupported.ZoneId | The specified ZoneId does not support the operation. | - |
| 400 | MissingParam.CenIdOrRegionId | Either CenId or RegionId must be specified. | CenId或者RegionId是必選參數。 |
| 400 | IllegalParam.RegionId | RegionId is illegal. | 參數中指定的Region不合法。 |
| 400 | OperationUnsupported.CenFullLevel | CEN full level does not support TransitRouter | Full類型CEN不支持創建企業版轉發路由器。 |
| 400 | InvalidOperation.CenInstanceStatus | The CEN instance is not in a valid state for the operation. | - |
| 400 | IllegalParam.ZoneMappings | The Specified Parameter ZoneMappings is illegal | 參數中指定的ZoneMappings不合法。 |
| 400 | IncorrectStatus.TransitRouter | The status of TransitRouter is incorrect. | 當前TransitRouter的狀態不支持該操作，請稍后重試。 |
| 400 | InvalidOperation.VpnNetworkTypeInvalid | The network type of child-instance is invalid. | 該實例的network type不合法。 |
| 400 | QuotaExceeded.CenQuotaVpnAttachPerTransitRouter | The maximum number of VPN attachment per Transit Router is exceeded. | 每個轉發路由器支持創建的VPN連接個數超限，可提交工單提升額度。 |
| 400 | QuotaFull.ChildInstanceRelatedCen | The childinstance has exceed the quota of the times that a childinstance can be attached as an attachment. | 該實例綁定CEN數量已達到上限，無法加載。 |
| 400 | Forbidden.ResourceOwnerTransitRouterServiceNotOpen | The resource owner user has not opened transit router service. | 資源所屬賬號轉發路由器服務未開通，請通知對方開通后重試。 |
| 400 | IllegalParam.RegionId | The Specified Parameter RegionId is illegal | 參數中指定的Region不合法。 |
| 400 | OperationUnsupported.VcoTunnelNotMatchZoneParam | The tunnel type of the entered Vco does not match the Zone parameter. | 輸入的Vco的隧道類型和Zone參數不匹配。 |
| 400 | Forbidden.ResourceOwnerTransitRouterServiceExpired | The transit router service of the account to which the resource belongs has been suspended due to arrears. Please notify the other party to renew the service and try again. | 資源所屬賬號的轉發路由器服務已欠費停服，請通知對方續費后重試。 |
| 400 | Forbidden.TransitRouterServiceExpired | The transit router service is out of service. | 轉發路由器服務已欠費停服，請續費后重試。 |
| 400 | InvalidParameter | Invalid parameter. | 參數不合法。 |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號無權限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-01-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2022-12-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |