您可以調用CreateTransitRouterVbrAttachment接口將要互通的邊界路由器VBR(Virtual Border Router)網絡實例連接到同地域的轉發路由器實例中。連接后,轉發路由器可幫您實現私網互通。
接口說明
-
企業版轉發路由器支持的地域和可用區信息,請參見什么是云企業網。
-
您可以通過以下兩種方式在企業版轉發路由器下創建 VBR 連接:
- 如果您已經在目標地域創建了企業版轉發路由器實例,您可以通過指定 VbrId、RegionId 和 TransitRouterId 創建 VBR 連接。
- 如果您在目標地域沒有企業版轉發路由器實例,您可以通過指定 VbrId、CenId 和 RegionId 創建 VBR 連接。創建 VBR 連接時系統為您自動創建企業版轉發路由器實例。
-
CreateTransitRouterVbrAttachment 接口屬于異步接口,即系統會先返回一個 VBR 連接 ID,但該 VBR 連接并未創建完成,系統后臺的創建任務仍在進行。您可以調用 ListTransitRouterVbrAttachments 接口查詢 VBR 連接的狀態。
- 當 VBR 連接處于 Attaching 狀態時,表示 VBR 連接正在創建中,在該狀態下,您只能對 VBR 連接執行查詢操作,不能執行其他操作。
- 當 VBR 連接處于 Attached 狀態時,表示 VBR 連接創建完成。
-
轉發路由器所屬的阿里云賬號和 VBR 實例所屬的阿里云賬號屬于同一家企業。
-
轉發路由器支持連接同賬號和跨賬號的 VBR 實例。在創建跨賬號的 VBR 連接前,請先獲得跨賬號 VBR 實例的授權。具體操作,請參見跨賬號網絡實例授權。
-
創建 VBR 連接后,VBR 連接默認不與任何轉發路由器路由表建立路由學習關系和關聯轉發關系。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cen:CreateTransitRouterVbrAttachment | create | *CenInstance acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId} *TransitRouter acs:cen:*:{#accountId}:centransitrouter/{#TransitRouterId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 02fb3da4-130e-11e9-8e44-001**** |
CenId | string | 否 | 云企業網實例 ID。 | cen-j3jzhw1zpau2km**** |
TransitRouterId | string | 否 | 企業版轉發路由器實例 ID。 | tr-bp1su1ytdxtataupl**** |
RegionId | string | 否 | VBR 實例所屬地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
TransitRouterAttachmentName | string | 否 | VBR 連接名稱。 名稱可以為空或長度為 1~128 個字符,不能以 http://或 https://開頭。 | testname |
TransitRouterAttachmentDescription | string | 否 | VBR 連接描述。 描述可以為空或長度為 1~256 個字符,不能以 http://或 https://開頭。 | testdesc |
VbrId | string | 是 | VBR 實例 ID。 | vbr-bp1svadp4lq38janc**** |
VbrOwnerId | long | 否 | VBR 實例所屬阿里云賬號(主賬號)ID。默認值為當前登錄的阿里云賬號 ID。 說明
如果您要加載跨賬號的網絡實例,本參數必填。
| 1250123456123456 |
AutoPublishRouteEnabled | boolean | 否 | 是否使企業版轉發路由器自動發布路由到 VBR 實例。
| false |
DryRun | boolean | 否 | 是否對此次請求執行預檢,包括權限、實例狀態校驗等。取值:
| false |
Tag | array<object> | 否 | 標簽信息。 一次最多支持輸入 20 個標簽信息。 | |
object | 否 | |||
Key | string | 否 | 資源的標簽鍵。 一旦傳入該值,則不允許為空字符串。最多支持 64 個字符,不能以 一次最多支持輸入 20 個標簽的標簽鍵。 | TagKey |
Value | string | 否 | 資源的標簽值。 標簽值可以為空或輸入不超過 128 個字符的字符串,不能以 每一個標簽鍵對應一個標簽值,一次最多支持輸入 20 個標簽鍵對應的標簽值。 | TagValue |
返回參數
示例
正常返回示例
JSON
格式
{
"TransitRouterAttachmentId": "tr-attach-ia340z7xis7t5s****",
"RequestId": "C087A369-82B9-43EF-91F4-4B63A9C6E6B6"
}
錯誤碼
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 | OperationUnsupported.TransitRouterType | The specified TransitRouterType does not support the operation. | 當前TransitRouter類型不支持該操作。 |
400 | MissingParam.CenIdOrRegionId | Either CenId or RegionId must be specified. | CenId或者RegionId是必選參數。 |
400 | IncorrectStatus.Vpc | The resource is not in a valid state for the attachment operation. | 當前VPC的狀態不支持該操作,請稍后重試。 |
400 | Forbidden.VbrDeviceModel | Attach VBR on some access device models are forbidden. | vbr當前接入模式不支持該操作。 |
400 | IllegalParam.AssociateRouteTableId | The specified AssociateRouteTableId is illegal. | 參數中指定的AssociateRouteTableId不合法。 |
400 | Forbbiden.AttachChildInstanceAcrossBid | Operation is invalid, please apply for cross-bid attaching. | - |
400 | IllegalParam.RegionId | RegionId is illegal. | 參數中指定的Region不合法。 |
400 | OperationUnsupported.CenFullLevel | CEN full level does not support TransitRouter | Full類型CEN不支持創建企業版轉發路由器。 |
400 | OperationUnsupported.VbrAttachment | This region not support vbr attachment. | 該地域不支持加載vbrAttachment。 |
400 | InvalidOperation.CenInstanceStatus | The CEN instance is not in a valid state for the operation. | - |
400 | OperationUnsupported.CloudBoxVbrNotSupport | Cloud Box Vbr does not support. | 云盒實例不允許加載。 |
400 | IncorrectStatus.VbrResource | The resource is not in a valid state for the attachment operation. | 當前vbr資源不處于穩態,無法進行該操作,請等待與當前vbr相關操作結束后重試。 |
400 | IncorrectStatus.TransitRouter | The status of TransitRouter is incorrect. | 當前TransitRouter的狀態不支持該操作,請稍后重試。 |
400 | QuotaExceeded.CenQuotaVbrAttachPerTransitRouter | The maximum number of VBR attachment per Transit Router is exceeded. | 每個轉發路由器支持連接的邊界路由器VBR個數超限,可提交工單提升額度。 |
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 | InvalidOperation.VbrAttachedToEcr | VBR has alreay attached to ECR. | VBR已經綁定了ECR。 |
400 | IllegalParam.RegionId | The Specified Parameter RegionId is illegal | 參數中指定的Region不合法。 |
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. | 賬號無權限操作。 |
403 | Forbidden.VbrDeviceModel | The attached VBR on some access device models are not supported. Please submit a ticket to continue using this VBR on CEN. | Vbr當前接入模式不支持該操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-10-28 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-07-10 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-10 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-10-20 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-01-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2022-12-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |