文档

CreateVpcPeerConnection - 创建VPC对等连接

更新时间:

调用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暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

需要创建 VPC 对等连接的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
VpcIdstring

需要创建 VPC 对等连接发起端的 VPC ID。

vpc-bp1gsk7h12ew7oegk****
AcceptingAliUidlong

需要创建的 VPC 对等连接接收端的阿里云账号(主账号)ID。

  • 输入您的阿里云账号 ID,则创建同账号 VPC 对等连接。

  • 输入其他阿里云账号 ID,则创建跨账号 VPC 对等连接。

说明 如果接收端的账号为 RAM 用户(子账号),则 AcceptingAliUid 需要输入该 RAM 用户对应的阿里云账号 ID。
1210123456123456
AcceptingRegionIdstring

需要创建的 VPC 对等连接接收端的地域 ID。

  • 创建同地域 VPC 对等连接时,输入与发起端的地域 ID 相同的地域 ID。

  • 创建跨地域 VPC 对等连接时,输入与发起端的地域 ID 不同的地域 ID。

cn-hangzhou
AcceptingVpcIdstring

VPC 对等连接接收端的 VPC ID。

vpc-bp1vzjkp2q1xgnind****
Namestring

需要创建的 VPC 对等连接名称。

名称长度为 2~128 个字符,以英文字母或中文开头,可包含数字、下划线(_)和短划线(-)。

vpcpeer
Descriptionstring

需要创建的 VPC 对等连接描述信息。

长度为 2~256 个字符,必须以字母或中文开头,但不能以http://https://开头。

description
DryRunboolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会创建 VPC 对等连接。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。
false
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
02fb3da4-130e-11e9-8e44-001****
ResourceGroupIdstring

资源组 ID。

关于资源组的更多信息,请参见什么是资源组

rg-acfmxazb4ph6aiy****
Bandwidthinteger

需要创建的 VPC 对等连接的带宽值,单位:Mbps,取值范围为大于 0 的整数。如需指定该参数,请确保您创建的是跨地域的对等连接。

100

返回参数

名称类型描述示例值
object

请求 ID。

RequestIdstring

请求 ID。

54B48E3D-DF70-471B-AA93-08E683A1B45
InstanceIdstring

创建的 VPC 对等连接的实例 ID。

pcc-lnk0m24khwvtkm****

示例

正常返回示例

JSON格式

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "InstanceId": "pcc-lnk0m24khwvtkm****"
}

错误码

HTTP status code错误码错误信息描述
400OperationFailed.CdtNotOpenedThe operation failed because the Cdt service is not opened.创建操作失败,因为未开通Cdt服务
400OperationFailed.CrossBorderCdtNotOpenedThe operation failed because the CrossBorderCdt service is not opened.操作失败,因为未打开CrossBorderCdt服务。
400IncorrectStatus.VpcThe status of %s [%s] is incorrect.发起端VPC实例状态不正确。
400IncorrectStatus.AcceptingVpcThe status of %s [%s] is incorrect.接收端VPC状态不正确。
400ResourceAlreadyExist.RouterInterfaceThe specified resource of %s already exists.指定的路由器接口已经存在
400ResourceAlreadyExist.VpcPeerThe specified resource of %s already exists.指定的VpcPeer已经存在
400OperationDenied.CloudBoxExistsInVpcThe operation is not allowed because the CloudBox device exists in vpc.在发起端VPC内存在云盒实例,因此不允许创建VpcPeer实例。
400OperationDenied.CloudBoxExistsInAcceptingVpcThe operation is not allowed because the CloudBox device exists in accepting vpc.在接收端VPC内存在云盒实例,因此不允许创建VpcPeer实例。
400QuotaExceeded.VpcPeerCountPerVpcThe quota of %s is exceeded, usage %s/%s.指定VPC中的VpcPeer数量超出限制
400UnsupportedRegionThe feature of %s is not supported in the region of %s.VpcPeer特性在此地域不支持
400QuotaExceeded.VpcPeerCountPerUserPerRegionThe quota of %s is exceeded, usage %s/%s.单个地域内VpcPeer实例数量超过阈值。
400IncorrectBusinessStatus.VpcPeerThe business status of %s [%s] is incorrect.当前实例状态异常,不允许进行当前操作
400OperationFailed.NotExist.ResourceGroupThe operation failed because the resource group does not exist.资源组不存在,操作失败。
400OperationFailed.AcceptUserCdtNotOpenedThe operation failed because the Cdt service of accept user is not opened.对端Cdt服务未开通,操作失败。
400OperationFailed.AcceptUserCrossBorderCdtNotOpenedThe operation failed because the CrossBorderCdt service of accept user is not opened.对端跨境Cdt服务未开通,操作失败。
400IncorrectBusinessStatus.AcceptUserVpcPeerThe business status of %s [%s] is incorrect.对端VpcPeer商业状态异常。
400OperationFailed.ViolativeVpcPeerThe creation operation fails because it is not allowed to create a vpc peer instance between the originating region and the receiving region.创建操作失败是因为不允许创建发起地域与接受地域之间的vpc peer实例。
400OperationFailed.ViolativeVpcPeerThe operation failed because it is out of compliance to create a vpc peer between originating region and accepting region.创建操作失败是因为不允许创建发起地域与接受地域之间的vpc peer实例。
400QuotaExceeded.CrossRegionVpcPeerCountPerVpcThe quota of %s is exceeded, usage %s/%s.指定VPC中的跨地域VpcPeer数量超出限制
400QuotaExceeded.IntraRegionVpcPeerCountPerVpcThe quota of %s is exceeded, usage %s/%s.指定VPC中的同地域VpcPeer数量超出限制
400OperationDenied.OperateShareResourceThe operation is not allowed because of operating shared resource.操作共享资源导致操作失败

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-06-05OpenAPI 错误码发生变更查看变更详情
2024-03-13OpenAPI 错误码发生变更查看变更详情
2024-02-28OpenAPI 错误码发生变更查看变更详情
2023-11-20OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-05-30OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情