調用CreateVpcPeerConnection接口創建VPC對等連接。
接口說明
創建 VPC 對等連接前,您需要完成以下事項:
- CreateVpcPeerConnection 接口屬于異步接口,即系統會先返回一個 InstanceId,但該 VPC 對等連接實例并未創建完成,系統后臺的創建任務仍在進行。您可以調用 GetVpcPeerConnectionAttribute 查詢 VPC 對等連接的狀態。
- 當 VPC 對等連接處于 Creating 狀態時,表示 VPC 對等連接正在創建中。
- 當 VPC 對等連接處于 Activated 狀態時,表示 VPC 對等連接創建完成。
- 當 VPC 對等連接處于 Accepting 狀態時,為跨賬號場景,跨賬號場景需要在接收端接收。
- CreateVpcPeerConnection 接口不支持在同一個 VPC 下并發創建 VPC 對等連接。
創建 VPC 對等連接時,系統會為您自動開通非跨境云數據傳輸 CDT(Cloud DataTransfer)和跨境 CDT 功能。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vpc:CreateVpcPeerConnection | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 需要創建 VPC 對等連接的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
VpcId | string | 是 | 需要創建 VPC 對等連接發起端的 VPC ID。 | vpc-bp1gsk7h12ew7oegk**** |
AcceptingAliUid | long | 是 | 需要創建的 VPC 對等連接接收端的阿里云賬號(主賬號)ID。
說明
如果接收端的賬號為 RAM 用戶(子賬號),則 AcceptingAliUid 需要輸入該 RAM 用戶對應的阿里云賬號 ID。
| 1210123456123456 |
AcceptingRegionId | string | 是 | 需要創建的 VPC 對等連接接收端的地域 ID。
| cn-hangzhou |
AcceptingVpcId | string | 是 | VPC 對等連接接收端的 VPC ID。 | vpc-bp1vzjkp2q1xgnind**** |
Name | string | 否 | 需要創建的 VPC 對等連接名稱。 名稱長度為 2~128 個字符,以英文字母或中文開頭,可包含數字、下劃線(_)和短劃線(-)。 | vpcpeer |
Description | string | 否 | 需要創建的 VPC 對等連接描述信息。 長度為 2~256 個字符,必須以字母或中文開頭,但不能以 | description |
DryRun | boolean | 否 | 是否只預檢此次請求。取值:
| false |
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 由客戶端生成該參數值,要保證在不同請求間唯一,最大值不超過 64 個 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。
| 02fb3da4-130e-11e9-8e44-001**** |
ResourceGroupId | string | 否 | 資源組 ID。 關于資源組的更多信息,請參見什么是資源組。 | rg-acfmxazb4ph6aiy**** |
Bandwidth | integer | 否 | 需要創建的 VPC 對等連接的帶寬值,單位:Mbps,取值范圍為大于 0 的整數。 說明
如需指定該參數,請確保您創建的是跨地域的對等連接。
| 100 |
LinkType | string | 否 | 鏈路類型。 可選值為 Platinum(鉑金),Gold(金),默認為 Gold(金)。 說明
如需指定該參數,請確保您創建的是跨地域的對等連接。
| Gold |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
"InstanceId": "pcc-lnk0m24khwvtkm****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | OperationFailed.CdtNotOpened | The operation failed because the Cdt service is not opened. | 創建操作失敗,因為未開通Cdt服務 |
400 | OperationFailed.CrossBorderCdtNotOpened | The operation failed because the CrossBorderCdt service is not opened. | 操作失敗,因為未打開CrossBorderCdt服務。 |
400 | IncorrectStatus.Vpc | The status of %s [%s] is incorrect. | 發起端VPC實例狀態不正確。 |
400 | IncorrectStatus.AcceptingVpc | The status of %s [%s] is incorrect. | 接收端VPC狀態不正確。 |
400 | ResourceAlreadyExist.RouterInterface | The specified resource of %s already exists. | 指定的路由器接口已經存在 |
400 | ResourceAlreadyExist.VpcPeer | The specified resource of %s already exists. | 指定的VpcPeer已經存在 |
400 | OperationDenied.CloudBoxExistsInVpc | The operation is not allowed because the CloudBox device exists in vpc. | 在發起端VPC內存在云盒實例,因此不允許創建VpcPeer實例。 |
400 | OperationDenied.CloudBoxExistsInAcceptingVpc | The operation is not allowed because the CloudBox device exists in accepting vpc. | 在接收端VPC內存在云盒實例,因此不允許創建VpcPeer實例。 |
400 | QuotaExceeded.VpcPeerCountPerVpc | The quota of %s is exceeded, usage %s/%s. | 指定VPC中的VpcPeer數量超出限制 |
400 | UnsupportedRegion | The feature of %s is not supported in the region of %s. | VpcPeer特性在此地域不支持 |
400 | QuotaExceeded.VpcPeerCountPerUserPerRegion | The quota of %s is exceeded, usage %s/%s. | 單個地域內VpcPeer實例數量超過閾值。 |
400 | IncorrectBusinessStatus.VpcPeer | The business status of %s [%s] is incorrect. | 當前實例狀態異常,不允許進行當前操作 |
400 | OperationFailed.NotExist.ResourceGroup | The operation failed because the resource group does not exist. | 資源組不存在,操作失敗。 |
400 | OperationFailed.AcceptUserCdtNotOpened | The operation failed because the Cdt service of accept user is not opened. | 對端Cdt服務未開通,操作失敗。 |
400 | OperationFailed.AcceptUserCrossBorderCdtNotOpened | The operation failed because the CrossBorderCdt service of accept user is not opened. | 對端跨境Cdt服務未開通,操作失敗。 |
400 | IncorrectBusinessStatus.AcceptUserVpcPeer | The business status of %s [%s] is incorrect. | 對端VpcPeer商業狀態異常。 |
400 | OperationFailed.ViolativeVpcPeer | The creation operation fails because it is not allowed to create a vpc peer instance between the originating region and the receiving region. | 創建操作失敗是因為不允許創建發起地域與接受地域之間的vpc peer實例。 |
400 | OperationFailed.ViolativeVpcPeer | The operation failed because it is out of compliance to create a vpc peer between originating region and accepting region. | 創建操作失敗是因為不允許創建發起地域與接受地域之間的vpc peer實例。 |
400 | QuotaExceeded.CrossRegionVpcPeerCountPerVpc | The quota of %s is exceeded, usage %s/%s. | 指定VPC中的跨地域VpcPeer數量超出限制 |
400 | QuotaExceeded.IntraRegionVpcPeerCountPerVpc | The quota of %s is exceeded, usage %s/%s. | 指定VPC中的同地域VpcPeer數量超出限制 |
400 | OperationDenied.OperateShareResource | The operation is not allowed because of operating shared resource. | 操作共享資源導致操作失敗 |
400 | IncorrectBusinessStatus.AcceptVpcPeer | The business status of peer account is incorrect. | 對端VpcPeer商業狀態異常。 |
400 | OperationFailed.InterRegionLinkTypeNotSupported | The same region not supported link type feature. | 同地域不支持鏈路類型特性 |
400 | OperationFailed.RegionIdNotSupportLinkType | The feature link type is not supported in the region. | 地域不支持該特性金銀銅設置 |
400 | OperationFailed.SpecificLinkTypeNotSupported | The operation failed because the special link type of user is not opened. | 該賬號不支持特殊鏈路類型 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-12-04 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-08-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-07-02 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-06-05 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-03-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-02-28 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-11-20 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-05-30 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |