網絡實例(VPC、VBR、IPsec連接)被連接至轉發路由器后,如果要實現不同地域網絡實例的互通,需要在網絡實例連接的轉發路由器下創建跨地域連接,您可以調用CreateTransitRouterPeerAttachment接口為企業版轉發路由器實例創建跨地域連接。
接口說明
-
企業版轉發路由器支持以下兩種帶寬分配方式:
-
從帶寬包分配:
使用此種分配方式,您需要先購買帶寬包,從帶寬包中為跨地域連接分配帶寬。購買帶寬包具體操作,請參見 CreateCenBandwidthPackage 。
-
按流量付費:
使用此種分配方式,您需要為跨地域連接設置限速帶寬,系統會按照跨地域連接實際使用的流量計費。具體計費信息,請參見跨地域流量。
-
-
CreateTransitRouterPeerAttachment 接口屬于異步接口,即系統會先返回一個跨地域連接 ID,但該跨地域連接并未創建完成,系統后臺的創建任務仍在進行。您可以調用 ListTransitRouterPeerAttachments 接口查詢跨地域連接的狀態。
- 當跨地域連接處于 Attaching 狀態時,表示跨地域連接正在創建中,在該狀態下,您只能對跨地域連接執行查詢操作,不能執行其他操作。
- 當跨地域連接處于 Attached 狀態時,表示跨地域連接創建完成。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cen:CreateTransitRouterPeerAttachment | 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 | 否 | 本端企業版轉發路由器實例所屬地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
TransitRouterAttachmentName | string | 否 | 跨地域連接的名稱。 名稱可以為空或長度為 1~128 個字符,不能以 http://或 https://開頭。 | testname |
TransitRouterAttachmentDescription | string | 否 | 跨地域連接的描述信息。 描述可以為空或長度為 1~256 個字符,不能以 http://或 https://開頭。 | testdesc |
PeerTransitRouterId | string | 是 | 對端轉發路由器實例 ID。 | tr-m5eq27g6bndum7e88**** |
PeerTransitRouterRegionId | string | 否 | 對端轉發路由器實例所屬地域 ID。 | cn-qingdao |
AutoPublishRouteEnabled | boolean | 否 | 是否使企業版轉發路由器自動發布跨地域連接的路由到對端地域。
| false |
Bandwidth | integer | 否 | 跨地域連接的帶寬值。單位:Mbps。
| 2 |
CenBandwidthPackageId | string | 否 | 跨地域連接要綁定的帶寬包 ID。 說明
當 BandwidthType 取值為 DataTransfer 時,無需配置該項。
| cenbwp-3xrxupouolw5ou**** |
DryRun | boolean | 否 | 是否對此次請求執行預檢,包括權限、實例狀態校驗等。取值:
| false |
BandwidthType | string | 否 | 跨地域連接的帶寬分配方式。取值:
| BandwidthPackage |
Tag | array<object> | 否 | 標簽信息。 一次最多支持輸入 20 個標簽信息。 | |
object | 否 | |||
Key | string | 否 | 資源的標簽鍵。 一旦傳入該值,則不允許為空字符串。最多支持 64 個字符,不能以 一次最多支持輸入 20 個標簽的標簽鍵。 | tag_A1 |
Value | string | 否 | 資源的標簽值。 標簽值可以為空或輸入不超過 128 個字符的字符串,不能以 每一個標簽鍵對應一個標簽值,一次最多支持輸入 20 個標簽鍵對應的標簽值。 | value_A1 |
DefaultLinkType | string | 否 | 默認鏈路類型。 可選值為 Platinum(鉑金),Gold(金),默認為 Gold(金)。 且僅在帶寬分配方式是按流量計費時,才可以配置為 Platinum(鉑金)。 | Gold |
返回參數
示例
正常返回示例
JSON
格式
{
"TransitRouterAttachmentId": "tr-attach-nwkiqfvw22qesz****",
"RequestId": "59422BF5-BAAD-4CFD-9019-9557BD3ACFA3"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | OperationUnsupported.TransitRouterRegionId | The specified TransitRouterRegion does not support the operation. | 中轉地域不支持此操作。 |
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 | InvalidTransitRouterId.NotFound | TransitRouterId is not found. | 轉發路由實例ID不存在。 |
400 | IllegalParam.PeerTransitRouterId | PeerTransitRouterId is illegal. | 跨地域連接時,對端的轉發路由器ID非法。 |
400 | OperationUnsupported.TransitRouterId | TransitRouterId is unsupported. | 轉發路由器類型是基礎版時不支持。 |
400 | MissingParam.Bandwidth | The parameter Bandwidth is mandatory. | 帶寬值參數是必需的。 |
400 | IllegalParam.Bandwidth | Bandwidth is illegal. | 帶寬包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 | OperationUnsupported.BandwidthType | The specified BandwidthType does not support the operation. | 當前BandwidthType不支持該操作。 |
400 | InvalidCenId.NotFound | CenId is not found. | CEN實例不存在。 |
400 | IllegalParam.BandwidthType | BandwidthType is illegal. | 帶寬包類型不合法。 |
400 | MissingParam.CenIdOrRegionId | Either CenId or RegionId must be specified. | CenId或者RegionId是必選參數。 |
400 | OperationUnsupported.BandwidthHS | This bandwidth limit can only be set in China-AsiaPacific-HS | - |
400 | OperationUnsupported.CenFullLevel | CEN full level does not support TransitRouter | Full類型CEN不支持創建企業版轉發路由器。 |
400 | OperationUnsupported.CloudDataTransferService | CCN region not support cloud data transfer service. | CCN地域中不支持cloud data transfer服務。 |
400 | InvalidPeerTransitRouterId.NotFound | The specified PeerTransitRouterId is not found. | 參數中指定的PeerTransitRouterId不存在。 |
400 | IllegalParam.RegionId | RegionId is illegal. | 參數中指定的Region不合法。 |
400 | IllegalParam.PeerRegionId | PeerRegionId is illegal. | 參數中指定的PeerRegionId不合法。 |
400 | IllegalParam.TransitRouterRegionId | TransitRouterRegionId is illegal. | TransitRouterRegionId不合法。 |
400 | InvalidOperation.CenInstanceStatus | The CEN instance is not in a valid state for the operation. | - |
400 | IncorrectStatus.TransitRouter | The status of TransitRouter is incorrect. | 當前TransitRouter的狀態不支持該操作,請稍后重試。 |
400 | InvalidOperation.BwpNotAssociated | Operation is invalid because a bandwidth package corresponding to the geographic span is not associated. | 與地域對應的帶寬包未關聯,無法操作。 |
400 | InvalidOperation.BwpBusinessStatus | The CBN bandwidth package is not in a valid business state for the operation. | 帶寬包不處于穩態,無法操作。 |
400 | IllegalParam.CenBandwidthPackageId | Parameter CenBandwidthPackageId is illegal. | 參數中指定的CenBandwidthPackageId不合法。 |
400 | InvalidOperation.BwpBandwidthExceeded | Operation is invalid because the total bandwidth limit has exceeded that of the bandwidth package. | 設置帶寬值已超出帶寬包帶寬 |
400 | ParameterIllegal.CdtDefaultLinkTypeOnlySupportPlatinumOrGold | DataTransfer only support Platinum and Gold. | 帶寬分配方式為按流量計費時,默認鏈路類型僅支持鉑金(Platinum)和金(Gold)。 |
400 | ParameterIllegal.BandwidthPackageDefaultLinkTypeOnlySupportGold | Cen bandwidthPackage only support Gold. | 帶寬分配方式為帶寬包時,默認鏈路類型僅支持金(Gold) |
400 | ParameterIllegal.CdtDefaultLinkTypeOnlySupportGold | CDT only support Gold when both transitrouters for cross regional connections are not all enterprise version. | 當跨地域連接的兩端轉發路由器不全是企業版且帶寬分配方式為按流量計費時,默認鏈路類型僅支持金(Gold)。 |
400 | OperationNotAllowed.DefaultLinkTypeOnlySupportGold | Operation is not allowed because this user can only set default link type to Gold. | 本用戶只能設置默認鏈路類型為金。 |
400 | OperationInvalid.UserCanNotBuyCrossBorderBwp | According to the laws and regulations of the operator and mainland China, you are currently not eligible to purchase or renew a cross-border bandwidth package. Please contact online customer service or your business manager for consultation. | 根據運營商及中國大陸法律法規的要求,您當前暫不符合購買/續費跨境帶寬包條件,請聯系在線客服或您的商務經理咨詢處理。 |
400 | OperationInvalid.IdentityRegistrationStatusNotSupport | Real name registration of enterprises required. | 因您在“地域”或“對端地域”選擇了“中國內地”的地域,您需要是企業用戶且已完成企業實名登記,才能繼續購買。關于如何做企業實名登記,請查看<a href=" https://www.alibabacloud.com/help/doc-detail/52595.htm">實名認證文檔 |
400 | InvalidOperation.OnlyOneRegionSupportIpv6 | Peer Attachment is only allowed when both regions support IPv6 or do not support IPv6 at all. | 只有當兩端地域均支持或均不支持IPv6時才可以創建跨地域連接。 |
400 | InvalidOperation | Operation is invalid. | 非法操作。 |
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 | OperationUnsupported.RegionId | The specified RegionId does not support the operation. | 當前地域不支持該操作。 |
400 | InvalidParameter | Invalid parameter. | 參數不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號無權限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-10-28 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-06-11 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-05-17 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-20 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-06 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-11-03 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-10-18 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-10-18 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-01-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2022-12-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |