Creates a virtual private cloud (VPC) peering connection.

Usage notes

Before you create a VPC peering connection, make sure that the following requirements are met:

  • Cloud Data Transfer (CDT) is activated to manage the billing of intra-border data transfers. To activate CDT, call the OpenCdtService operation.
  • CreateVpcPeerConnection is an asynchronous operation. After a request is sent, the system returns a request ID and a VPC ID and runs the task in the background. You can call the GetVpcPeerConnectionAttribute operation to query the status of a the task.
    • If a VPC peering connection is in the Creating state, the VPC peering connection is being created.
    • If a VPC peering connection is in the Activated state, the VPC peering connection is created.
    • If a VPC peering connection is in the Accepting state, the VPC peering connection is created across accounts and the accepter is accepting the VPC peering connection.
  • You cannot repeatedly call the CreateVpcPeerConnection operation within a specific period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateVpcPeerConnection

The operation that you want to perform. Set the value to CreateVpcPeerConnection.

RegionId String Yes cn-hangzhou

The ID of the region where you want to create a VPC peering connection.

You can call the DescribeRegions operation to query the most recent region list.

VpcId String Yes vpc-bp1gsk7h12ew7oegk****

The ID of the requester VPC.

AcceptingAliUid Long Yes 1210123456123456

The ID of the Alibaba Cloud account to which the accepter VPC belongs.

  • To create a VPC peering connection within your Alibaba Cloud account, enter the ID of your Alibaba Cloud account.
  • To create a VPC peering connection between your Alibaba Cloud account and another Alibaba Cloud account, enter the ID of the peer Alibaba Cloud account.
    Note If the accepter VPC belongs to a Resource Access Management (RAM) user, you must set the value of AcceptingAliUid to the ID of the corresponding Alibaba Cloud account.
AcceptingRegionId String Yes cn-hangzhou

The region ID of the accepter VPC of the VPC peering connection that you want to create.

  • To create an intra-region VPC peering connection, enter a region ID that is the same as that of the requester VPC.
  • To create an inter-region VPC peering connection, enter a region ID that is different from that of the requester VPC.
AcceptingVpcId String Yes vpc-bp1vzjkp2q1xgnind****

The ID of the accepter VPC.

Name String No vpcpeer

The name of the VPC peering connection.

The name must be 2 to 128 characters in length and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter.

Description String No description

The description of the VPC peering connection.

The description must be 2 to 256 characters in length. The description must start with a letter but cannot start with http:// or https://.

DryRun Boolean No false

Specifies whether to perform only a dry run, without performing the actual request. Valid values:

  • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
  • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
ClientToken String No 02fb3da4-130e-11e9-8e44-001****

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

Note If you do not specify this parameter, the system automatically uses the client token as the request ID. The request ID may be different for each request.
ResourceGroupId String No rg-acfmxazb4ph6aiy****

The ID of the resource group.

For more information about resource groups, see What is a resource group?

Response parameters

Parameter Type Example Description
RequestId String 54B48E3D-DF70-471B-AA93-08E683A1B45

The request ID.

InstanceId String pcc-lnk0m24khwvtkm****

The ID of the VPC peering connection.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateVpcPeerConnection
&RegionId=cn-hangzhou
&VpcId=vpc-bp1gsk7h12ew7oegk****
&AcceptingAliUid=1210123456123456
&AcceptingRegionId=cn-hangzhou
&AcceptingVpcId=vpc-bp1vzjkp2q1xgnind****
&Name=vpcpeer
&Description=description
&DryRun=false
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&ResourceGroupId=rg-acfmxazb4ph6aiy****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateVpcPeerConnectionResponse>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>
    <InstanceId>pcc-lnk0m24khwvtkm****</InstanceId>
</CreateVpcPeerConnectionResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 OperationFailed.CdtNotOpened The operation failed because the Cdt service is not opened. The operation failed because Cloud Data Transfer (CDT) is not activated.
400 ResourceAlreadyExist.RouterInterface The specified resource of %s already exists. The specified router interface already exists.
400 ResourceAlreadyExist.VpcPeer The specified resource of %s already exists. The specified VPC peering connection already exists.
400 UnsupportedRegion The feature of %s is not supported in the region of %s. VPC peering connections are not supported in this region.
400 OperationFailed.NotExist.ResourceGroup The operation failed because the resource group does not exist. 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. The operation failed because CDT is not activated for the peer.
400 OperationFailed.AcceptUserCrossBorderCdtNotOpened The operation failed because the CrossBorderCdt service of accept user is not opened. The operation failed because the cross-border service of CDT is not activated for the peer.
400 IncorrectBusinessStatus.AcceptUserVpcPeer The business status of %s [%s] is incorrect. The peer VPC is in an invalid business state.

For a list of error codes, see Service error codes.