createVpcPeeringInstance

Prev Next

Can be used in a VPC environment.

Overview

Create the VPC Peering instance through the Peering request.

Request

Request parameter

Parameter Name Required Status Type Restrictions Description
regionCode No String Region Code
You can decide the region where a VPC Peering instance will be created.
The regionCode can be obtained through the getRegionList action.
Default: Select the first region of the getRegionList query results.
vpcPeeringName No String Min : 3, Max : 30
Only lowercase letters, numbers, and special characters "-" are allowed and it must start with an alphabetic character.
It must end with an alphabet letter or number.
The name of the VPC Peering instance to be created
Default: NAVER Cloud Platform automatically assigns it.
sourceVpcNo Yes String The VPC number that sends the request
The sourceVpcNo can be obtained through the getVpcList action.
targetVpcNo Yes String The VPC number that receives the request
targetVpcNo can be obtained through the getVpcList action in the account that receives the request.
If the IPv4 CIDR blocks of the VPC sending the request and the VPC sending the request overlap, you can't connect with VPC Peering.
targetVpcName Conditional String The name of the VPC that receives the request
If the account receiving the request is different from the account sending the request, then you have to enter the name of the VPC receiving the request.
targetVpcLoginId Conditional String Owner ID of the VPC receiving the request
If the account receiving the request is different from the account sending the request, then you have to enter the account that receives the request.
It has to match the email format.
vpcPeeringDescription No String Min : 0, Max : 1000 Bytes The description about the VPC Peering instance to be created
responseFormatType No String Format type for the response result
Options : xml | json
Default : xml

Response

Response data type

  • VpcPeeringInstanceList type
VpcPeeringInstanceList extends CommonResponse
private Integer totalRows;
private List vpcPeeringInstanceList = new ArrayList<>();
VpcPeeringInstance
private String vpcPeeringInstanceNo;
private String vpcPeeringName;
private String regionCode;
private Date createDate;
private Date lastModifyDate;
private CommonCode vpcPeeringInstanceStatus;
private String vpcPeeringInstanceStatusName;
private CommonCode vpcPeeringInstanceOperation;
private String sourceVpcNo;
private String sourceVpcName;
private String sourceVpcIpv4CidrBlock;
private String sourceVpcLoginId;
private String targetVpcNo;
private String targetVpcName;
private String targetVpcIpv4CidrBlock;
private String targetVpcLoginId;
private String vpcPeeringDescription;
private Boolean hasReverseVpcPeering;
private Boolean isBetweenAccounts;
private String reverseVpcPeeringInstanceNo;

Example

Request example

ncloud vpc createVpcPeeringInstance --regionCode KR --vpcPeeringName test-*** --sourceVpcNo ***05 --targetVpcNo ***06

Response example

<createVpcPeeringInstanceResponse>
  <requestId>450c98e2-dca5-46f7-9f35-5ec1a1728213</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <vpcPeeringInstanceList>
    <vpcPeeringInstance>
      <vpcPeeringInstanceNo>***6212</vpcPeeringInstanceNo>
      <vpcPeeringName>test-***</vpcPeeringName>
      <regionCode>KR</regionCode>
      <createDate>2020-08-07T17:53:06+0900</createDate>
      <vpcPeeringInstanceStatus>
        <code>INIT</code>
        <codeName>init</codeName>
      </vpcPeeringInstanceStatus>
      <vpcPeeringInstanceStatusName>Waiting</vpcPeeringInstanceStatusName>
      <vpcPeeringInstanceOperation>
        <code>NULL</code>
        <codeName>NULL OP</codeName>
      </vpcPeeringInstanceOperation>
      <sourceVpcNo>***05</sourceVpcNo>
      <sourceVpcName>test-***</sourceVpcName>
      <sourceVpcIpv4CidrBlock>***.**1.0.0/16</sourceVpcIpv4CidrBlock>
      <sourceVpcLoginId>test-***@naver.com</sourceVpcLoginId>
      <targetVpcNo>***06</targetVpcNo>
      <targetVpcName>test-***</targetVpcName>
      <targetVpcIpv4CidrBlock>***.**2.0.0/16</targetVpcIpv4CidrBlock>
      <targetVpcLoginId>test-***@naver.com</targetVpcLoginId>
      <vpcPeeringDescription></vpcPeeringDescription>
      <hasReverseVpcPeering>false</hasReverseVpcPeering>
      <isBetweenAccounts>false</isBetweenAccounts>
      <reverseVpcPeeringInstanceNo></reverseVpcPeeringInstanceNo>
    </vpcPeeringInstance>
  </vpcPeeringInstanceList>
</createVpcPeeringInstanceResponse>