All Products
Search
Document Center

Virtual Private Cloud:CreateVpcPeerConnection

Last Updated:Nov 30, 2023

Creates a VPC peering connection

Operation Description

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 an instance ID and runs the task in the background. You can call the GetVpcPeerConnectionAttribute operation to query the status of 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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:CreateVpcPeerConnectionWrite
  • VpcPeer
    acs:vpc::{#accountId}:vpcpeer/*
  • VPC
    acs:vpc:{#regionId}:{#accountId}:vpc/{#InitiatingVpcId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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.

cn-hangzhou
VpcIdstringYes

The ID of the requester VPC.

vpc-bp1gsk7h12ew7oegk****
AcceptingAliUidlongYes

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 is a RAM user, set AcceptingAliUid to the ID of the Alibaba Cloud account that created the RAM user.
1210123456123456
AcceptingRegionIdstringYes

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.
cn-hangzhou
AcceptingVpcIdstringYes

The ID of the accepter VPC.

vpc-bp1vzjkp2q1xgnind****
NamestringNo

The name of the VPC peering connection.

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

vpcpeer
DescriptionstringNo

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://.

description
DryRunbooleanNo

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 code 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.
false
ClientTokenstringNo

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 request ID as the client token. The request ID may be different for each request.
02fb3da4-130e-11e9-8e44-001****
ResourceGroupIdstringNo

The ID of the resource group.

For more information about resource groups, see Resource groups.

rg-acfmxazb4ph6aiy****
BandwidthintegerNo

The bandwidth of the VPC peering connection. Unit: Mbit/s. The value must be an integer greater than 0. Before you specify this parameter, make sure that you create an inter-region VPC peering connection.

100

Response parameters

ParameterTypeDescriptionExample
object

The request ID.

RequestIdstring

The request ID.

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

The ID of the instance on which the VPC peering connection is created.

pcc-lnk0m24khwvtkm****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400OperationFailed.CdtNotOpenedThe operation failed because the Cdt service is not opened.The operation failed because CDT is not activated.
400OperationFailed.CrossBorderCdtNotOpenedThe operation failed because the CrossBorderCdt service is not opened.-
400IncorrectStatus.VpcThe status of %s [%s] is incorrect.-
400IncorrectStatus.AcceptingVpcThe status of %s [%s] is incorrect.-
400ResourceAlreadyExist.RouterInterfaceThe specified resource of %s already exists.The specified router interface already exists.
400ResourceAlreadyExist.VpcPeerThe specified resource of %s already exists.The specified VPC peering connection already exists.
400OperationDenied.CloudBoxExistsInVpcThe operation is not allowed because the CloudBox device exists in vpc.-
400OperationDenied.CloudBoxExistsInAcceptingVpcThe operation is not allowed because the CloudBox device exists in accepting vpc.-
400QuotaExceeded.VpcPeerCountPerVpcThe quota of %s is exceeded, usage %s/%s.The number of VPC peering connections to the VPC has reached the upper limit.
400UnsupportedRegionThe feature of %s is not supported in the region of %s.VPC peering connections are not supported in this region.
400UnsupportedFeature.VpcPeerThe feature of %s is not supported.-
400QuotaExceeded.VpcPeerCountPerUserPerRegionThe quota of %s is exceeded, usage %s/%s.-
400IncorrectBusinessStatus.VpcPeerThe business status of %s [%s] is incorrect.-
400OperationFailed.NotExist.ResourceGroupThe operation failed because the resource group does not exist.The operation failed because the resource group does not exist.
400OperationFailed.AcceptUserCdtNotOpenedThe operation failed because the Cdt service of accept user is not opened.The operation failed because CDT is not activated for the peer.
400OperationFailed.AcceptUserCrossBorderCdtNotOpenedThe 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.
400IncorrectBusinessStatus.AcceptUserVpcPeerThe business status of %s [%s] is incorrect.The peer VPC is in an invalid business state.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-11-20API Description Update,The error codes of the API operation change.,The input parameters of the API operation change.see changesets
Change itemChange content
API DescriptionAPI Description Update
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: Bandwidth
2023-05-30The error codes of the API operation change.,The input parameters of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    Error Codes 400 change
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: ResourceGroupId