調(diào)用CreateTransitRouterVpcAttachment接口將要互通的專有網(wǎng)絡(luò)VPC（Virtual Private Cloud）實(shí)例連接至轉(zhuǎn)發(fā)路由器實(shí)例。連接后，轉(zhuǎn)發(fā)路由器實(shí)例可以幫助您實(shí)現(xiàn)私網(wǎng)互通。
接口說(shuō)明
-
您可以通過(guò)以下兩種方式在企業(yè)版轉(zhuǎn)發(fā)路由器下創(chuàng)建 VPC 連接：
- 如果您已經(jīng)在目標(biāo)地域創(chuàng)建了企業(yè)版轉(zhuǎn)發(fā)路由器實(shí)例，您可以通過(guò)指定 VpcId、ZoneMappings.N.VSwitchId、ZoneMappings.N.ZoneId和 TransitRouterId、RegionId 創(chuàng)建 VPC 連接。
- 如果您在目標(biāo)地域沒(méi)有企業(yè)版轉(zhuǎn)發(fā)路由器實(shí)例，您可以通過(guò)指定 VpcId、ZoneMappings.N.VSwitchId、ZoneMappings.N.ZoneId、CenId 和 RegionId 創(chuàng)建 VPC 連接。創(chuàng)建 VPC 連接時(shí)系統(tǒng)為您自動(dòng)創(chuàng)建企業(yè)版轉(zhuǎn)發(fā)路由器實(shí)例。
-
CreateTransitRouterVpcAttachment 接口屬于異步接口，即系統(tǒng)會(huì)先返回一個(gè) VPC 連接 ID，但該 VPC 連接并未創(chuàng)建完成，系統(tǒng)后臺(tái)的創(chuàng)建任務(wù)仍在進(jìn)行。您可以調(diào)用 ListTransitRouterVpcAttachments 接口查詢 VPC 連接的狀態(tài)。
- 當(dāng) VPC 連接處于 Attaching 狀態(tài)時(shí)，表示 VPC 連接正在創(chuàng)建中，在該狀態(tài)下，您只能對(duì) VPC 連接執(zhí)行查詢操作，不能執(zhí)行其他操作。
- 當(dāng) VPC 連接處于 Attached 狀態(tài)時(shí)，表示 VPC 連接創(chuàng)建完成。
-
創(chuàng)建 VPC 連接后，VPC 連接默認(rèn)不與任何轉(zhuǎn)發(fā)路由器路由表建立路由學(xué)習(xí)關(guān)系和關(guān)聯(lián)轉(zhuǎn)發(fā)關(guān)系。
前提條件
在調(diào)用本接口創(chuàng)建 VPC 連接前，請(qǐng)確保滿足以下條件：
- VPC 實(shí)例在企業(yè)版轉(zhuǎn)發(fā)路由器支持的可用區(qū)擁有至少一個(gè)交換機(jī)實(shí)例，且該交換機(jī)實(shí)例擁有至少一個(gè)空閑的 IP 地址。關(guān)于企業(yè)版轉(zhuǎn)發(fā)路由器支持的地域和可用區(qū)信息，請(qǐng)參見(jiàn)企業(yè)版轉(zhuǎn)發(fā)路由器支持的地域和可用區(qū)。
- 如果您要連接跨賬號(hào)的網(wǎng)絡(luò)實(shí)例，請(qǐng)先獲得跨賬號(hào)網(wǎng)絡(luò)實(shí)例授權(quán)。具體操作，請(qǐng)參見(jiàn)跨賬號(hào)網(wǎng)絡(luò)實(shí)例授權(quán)。
- VPC 連接創(chuàng)建后會(huì)產(chǎn)生費(fèi)用，請(qǐng)確保您已經(jīng)了解相關(guān)計(jì)費(fèi)規(guī)則。更多信息，請(qǐng)參見(jiàn)計(jì)費(fèi)說(shuō)明。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫(xiě)入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| cen:CreateTransitRouterVpcAttachment | create | *CenInstance acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}*TransitRouter acs:cen:*:{#accountId}:centransitrouter/{#TransitRouterId} |
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClientToken | string | 否 | 客戶端 Token，用于保證請(qǐng)求的冪等性。 從您的客戶端生成一個(gè)參數(shù)值，確保不同請(qǐng)求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 說(shuō)明
若您未指定，則系統(tǒng)自動(dòng)使用 API 請(qǐng)求的 RequestId 作為 ClientToken 標(biāo)識(shí)。每次 API 請(qǐng)求的 RequestId 不一樣。
| 02fb3da4-130e-11e9-8e44-001**** |
| CenId | string | 否 | 云企業(yè)網(wǎng)實(shí)例 ID。 | cen-j3jzhw1zpau2km**** |
| TransitRouterId | string | 否 | 企業(yè)版轉(zhuǎn)發(fā)路由器實(shí)例 ID。 | tr-bp1su1ytdxtataupl**** |
| RegionId | string | 否 | VPC 實(shí)例所屬地域 ID。 您可以通過(guò)調(diào)用 DescribeChildInstanceRegions 接口獲取地域 ID。 | cn-hangzhou |
| TransitRouterAttachmentName | string | 否 | VPC 連接的名稱。 名稱可以為空或長(zhǎng)度為 1～128 個(gè)字符，不能以 http://或 https://開(kāi)頭。 | testname |
| TransitRouterAttachmentDescription | string | 否 | VPC 連接的描述信息。 描述可以為空或長(zhǎng)度為 1～256 個(gè)字符，不能以 http://或 https://開(kāi)頭。 | testname |
| VpcId | string | 是 | VPC 實(shí)例 ID。 | vpc-bp1kbjcre9vtsebo1**** |
| VpcOwnerId | long | 否 | VPC 實(shí)例所屬阿里云賬號(hào)（主賬號(hào)）ID。默認(rèn)值為當(dāng)前登錄的阿里云賬號(hào) ID。 說(shuō)明
如果您要加載跨賬號(hào)的網(wǎng)絡(luò)實(shí)例，本參數(shù)必填。
| 1250123456123456 |
| ChargeType | string | 否 | 付費(fèi)方式。默認(rèn)值：POSTPAY，表示按量付費(fèi)。 | POSTPAY |
| DryRun | boolean | 否 | 是否對(duì)此次請(qǐng)求執(zhí)行預(yù)檢，包括權(quán)限、實(shí)例狀態(tài)校驗(yàn)等。取值：
| false |
| ZoneMappings | array<object> | 是 | 請(qǐng)?jiān)谄髽I(yè)版轉(zhuǎn)發(fā)路由器的可用區(qū)中選擇一個(gè)交換機(jī)實(shí)例。 一次最多支持添加 10 組信息。 | |
| object | 是 | 企業(yè)版轉(zhuǎn)發(fā)路由器支持的可用區(qū)及其對(duì)應(yīng)的交換機(jī)實(shí)例的信息。 | ||
| VSwitchId | string | 是 | 在企業(yè)版轉(zhuǎn)發(fā)路由器支持的可用區(qū)中選擇一個(gè)交換機(jī)實(shí)例。 一次最多支持為 10 個(gè)可用區(qū)選擇交換機(jī)實(shí)例。 | vsw-bp1a214sbus8z3b54**** |
| ZoneId | string | 是 | 企業(yè)版轉(zhuǎn)發(fā)路由器支持的可用區(qū)的 ID。 您可以通過(guò) DescribeZones 接口查詢可用區(qū)的 ID。 一次最多支持選擇 10 個(gè)可用區(qū)。 | cn-hangzhou-h |
| AutoPublishRouteEnabled | boolean | 否 | 是否使企業(yè)版轉(zhuǎn)發(fā)路由器自動(dòng)發(fā)布路由到 VPC 實(shí)例。
| true |
| TransitRouterVPCAttachmentOptions | object | 否 | VPC 連接的功能屬性列表。 | |
| string | 否 | VPC 連接的功能屬性。 ipv6Support：是否開(kāi)啟 IPv6 功能。
說(shuō)明
為 VPC 連接開(kāi)啟 IPv6 功能前，請(qǐng)確保 VPC 實(shí)例及其關(guān)聯(lián)的交換機(jī)實(shí)例已經(jīng)開(kāi)啟 IPv6 功能。具體操作，請(qǐng)參見(jiàn) AllocateVpcIpv6Cidr 和 CreateVSwitchCidrReservation 。
| disable | |
| Tag | array<object> | 否 | 標(biāo)簽列表。 一次最多支持輸入 20 個(gè)標(biāo)簽信息。 | |
| object | 否 | 標(biāo)簽。 | ||
| Key | string | 否 | 資源的標(biāo)簽鍵。 一旦傳入該值，則不允許為空字符串。最多支持 64 個(gè)字符，不能以 一次最多支持輸入 20 個(gè)標(biāo)簽的標(biāo)簽鍵。 | tagtest |
| Value | string | 否 | 資源的標(biāo)簽值。 標(biāo)簽值可以為空或輸入不超過(guò) 128 個(gè)字符的字符串，不能以 每一個(gè)標(biāo)簽鍵對(duì)應(yīng)一個(gè)標(biāo)簽值，一次最多支持輸入 20 個(gè)標(biāo)簽鍵對(duì)應(yīng)的標(biāo)簽值。 | tagtest |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"TransitRouterAttachmentId": "tr-attach-ia340z7xis7t5s****",
"RequestId": "C087A369-82B9-43EF-91F4-4B63A9C6E6B6"
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | OperationUnsupported.TransitRouterRegionId | The specified TransitRouterRegion does not support the operation. | 中轉(zhuǎn)地域不支持此操作。 |
| 400 | NoPermission.AliyunServiceRoleForCEN | You are not authorized to create the service linked role. Role Name: AliyunServiceRoleForCEN. Service Name: cen.aliyuncs.com. Make sure that the user has been granted the ram:CreateServiceLinkedRole permission. | 您沒(méi)有權(quán)限創(chuàng)建服務(wù)關(guān)聯(lián)角色，角色名：AliyunServiceRoleForCEN，服務(wù)名：cen.aliyuncs.com。請(qǐng)確保已授予當(dāng)前用戶ram:CreateServiceLinkedRole權(quán)限。 |
| 400 | IllegalParam.RegionId | The Specified Parameter RegionId is illegal | 參數(shù)中指定的Region不合法。 |
| 400 | MissingParam.CenIdOrRegionId | Either CenId or RegionId must be specified. | CenId或者RegionId是必選參數(shù)。 |
| 400 | IllegalParam.ZoneId | The specified ZoneId is illegal. | 傳入的可用區(qū)非法 |
| 400 | IllegalParam.ChargeType | The specified ChargeType is illegal. | 付費(fèi)類型非法 |
| 400 | InvalidTransitRouterId.NotFound | The specified TransitRouterId is not found. | 指定的轉(zhuǎn)發(fā)路由器不存在 |
| 400 | IncorrectStatus.VpcResource | The resource is not in a valid state for the attachment operation. | 當(dāng)前VPC資源不處于穩(wěn)態(tài)，無(wú)法進(jìn)行該操作，請(qǐng)等待與當(dāng)前VPC相關(guān)操作結(jié)束后重試。 |
| 400 | IncorrectStatus.Vpc | The resource is not in a valid state for the attachment operation. | 當(dāng)前VPC的狀態(tài)不支持該操作，請(qǐng)稍后重試。 |
| 400 | IncorrectStatus.VpcOrVswitch | The Vpc Or Vswith is not in a valid state for the attachment operation. | 當(dāng)前vpc或vswitch的狀態(tài)不支持該操作，請(qǐng)稍后重試。 |
| 400 | OperationNotSupport.VpcAutoRoutesPublish | Auto publish vpc routes is not supported in this region. | 當(dāng)前地域暫不支持vpc路由自動(dòng)發(fā)布。 |
| 400 | InvalidOperation.VpnAssociated | The operation is not supported because the VPC is associated with VPN. | 當(dāng)前VPC與VPN綁定，無(wú)法打開(kāi)路由自動(dòng)同步功能。 |
| 400 | Forbbiden.TransitRouterServiceNotOpen | The user has not open transit router service. | 轉(zhuǎn)發(fā)路由器服務(wù)未打開(kāi)，請(qǐng)打開(kāi)后重試。 |
| 400 | IllegalParam.ZoneMappings | The Specified Parameter ZoneMappings is illegal | 參數(shù)中指定的ZoneMappings不合法。 |
| 400 | OperationUnsupported.TransitRouterType | The specified TransitRouterType does not support the operation. | 當(dāng)前TransitRouter類型不支持該操作。 |
| 400 | InvalidCenId.NotFound | CenId is not found. | CEN實(shí)例不存在。 |
| 400 | IllegalParam.VSwitchId | VSwitchId is illegal. | 參數(shù)中指定的VSwitchId不合法。 |
| 400 | IllegalParam.RegionId | RegionId is illegal. | 參數(shù)中指定的Region不合法。 |
| 400 | IncorrectStatus.TransitRouterInstance | The status of TransitRouter is incorrect. | 轉(zhuǎn)發(fā)路由器狀態(tài)不正確。 |
| 400 | OperationUnsupported.CenFullLevel | CEN full level does not support TransitRouter | Full類型CEN不支持創(chuàng)建企業(yè)版轉(zhuǎn)發(fā)路由器。 |
| 400 | IllegalParam.ServiceMode | ServiceMode is illegal. | ServiceMode不合法。 |
| 400 | QuotaFull.ChildInstanceRelatedCen | The childinstance has exceed the quota of the times that a childinstance can be attached as an attachment. | 該實(shí)例綁定CEN數(shù)量已達(dá)到上限，無(wú)法加載。 |
| 400 | OperationUnsupported.CloudBoxVswNotSupport | Cloud Box vsw does not support. | 云盒的vsw不允許加載。 |
| 400 | IncorrectStatus.TransitRouter | The status of TransitRouter is incorrect. | 當(dāng)前TransitRouter的狀態(tài)不支持該操作，請(qǐng)稍后重試。 |
| 400 | Duplicated.ZoneMapping | The parameter ZoneMapping is duplicated. | ZoneMapping中存在重復(fù)的條目。 |
| 400 | QuotaExceeded.CenQuotaVpcAttachPerTransitRouter | The maximum number of VPC attachment per Transit Router is exceeded. | 每個(gè)轉(zhuǎn)發(fā)路由器支持連接的專有網(wǎng)絡(luò)VPC個(gè)數(shù)超限。 |
| 400 | IncorrectStatus.VpcRouteTable | The VPC route table is not in a desired state. | 該操作相關(guān)的VPC路由表不處于穩(wěn)態(tài)，無(wú)法操作，請(qǐng)稍后重試。 |
| 400 | InvalidStatus.VpcAttachedFullModeCen | The VPC has been attached to another CEN instance whose protection level is FULL. | 參數(shù)中指定的vpc加載到另一個(gè)protection level為FULL的cen中，無(wú)法再加載到其他cen中。 |
| 400 | Forbbiden.AttachChildInstanceAcrossBid | VPCs that belong to another BID cannot be associated. You need to apply for cross-BID attaching. | 不允許綁定不同bid賬號(hào)下的VPC。 |
| 400 | InvalidOperation.VpcAutoRoutesPublishInOtherCEN | The specified VPC already has its routes synchronized with another CEN instance. | 當(dāng)前VPC已經(jīng)在其他CEN中開(kāi)啟了路由自動(dòng)同步，無(wú)法支持該操作。 |
| 400 | QuotaExceeded.VpcAutoRoutesPublishPerTransitRouter | The number of VPCs that have route synchronization enabled has reached the upper limit. | 開(kāi)啟路由自動(dòng)同步的VPC數(shù)量已達(dá)到上限。 |
| 400 | InsufficientIpAddr.vsw | Insufficient available IP addresses in the vSwitch. | 虛擬交換機(jī)中的可用IP數(shù)目不足 |
| 400 | Forbidden.ResourceOwnerTransitRouterServiceNotOpen | The resource owner user has not opened transit router service. | 資源所屬賬號(hào)轉(zhuǎn)發(fā)路由器服務(wù)未開(kāi)通，請(qǐng)通知對(duì)方開(kāi)通后重試。 |
| 400 | IllegalParam.TransitRouterRegionId | TransitRouterRegionId is illegal. | TransitRouterRegionId不合法。 |
| 400 | InvalidTransitRouterMode.NeedUpgrade | TransitRouter need to upgrade. | 當(dāng)前轉(zhuǎn)發(fā)路由器模式不支持。 |
| 400 | IllegalParam.Ipv6Support | Ipv6Support is illegal. Valid Values are [enable, disable]. | 請(qǐng)求參數(shù)Ipv6Support值非法，有效值為enable或disable。 |
| 400 | OperationFailed.VSwitchNotFound | The specified vswitch not found. | 指定的VSwitchId不存在，請(qǐng)確認(rèn)該VSwitch狀態(tài)是否可用或指定其他可用的VSwitch。 |
| 400 | OperationFailed.VSwitchIpv6CidrNotAllocated | The specified vswitch does not have IPv6 address allocated. | 指定的VSwitch未開(kāi)通Ipv6，請(qǐng)開(kāi)通Ipv6后再進(jìn)行該操作。 |
| 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. | 資源所屬賬號(hào)的轉(zhuǎn)發(fā)路由器服務(wù)已欠費(fèi)停服，請(qǐng)通知對(duì)方續(xù)費(fèi)后重試。 |
| 400 | Forbidden.TransitRouterServiceExpired | The transit router service is out of service. | 轉(zhuǎn)發(fā)路由器服務(wù)已欠費(fèi)停服，請(qǐng)續(xù)費(fèi)后重試。 |
| 400 | InvalidParameter | Invalid parameter. | 參數(shù)不合法。 |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號(hào)無(wú)權(quán)限操作。 |
| 404 | InvalidVSwitchId.NotFound | The specified VSwitchId is not found. | 指定的VSwitchId不存在。 |
| 409 | InvalidOperation.CenInstanceStatus | The CEN instance is not in a valid state for the operation. | cen當(dāng)前狀態(tài)不支持該操作，請(qǐng)稍后重試。 |
| 409 | IncorrectStatus.VpcSwitch | The resource is not in a valid state for the attachment operation. | 當(dāng)前Vswitch的狀態(tài)不支持該操作，請(qǐng)稍后重試。 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-11-21 | OpenAPI 描述信息更新、OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-10-28 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-09-10 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2024-04-19 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-03-13 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-01-10 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-09-08 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-03-14 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-01-04 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2022-12-22 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2022-10-19 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |