createVpcPeeringInstance

Prev Next

VPC環境で利用できます。

Peeringリクエストを通じて VPC Peeringインスタンスを作成します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET, POST /createVpcPeeringInstance

リクエストヘッダ

VPC APIで共通して使用されるヘッダの詳細は、VPCの共通ヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional VPC Peeringインスタンスを作成するリージョンコード
  • 照会結果の最初のリージョン(デフォルト)
  • getRegionListを通じて確認
  • vpcPeeringName String Optional 作成する VPC Peeringの名前
  • NAVERクラウドプラットフォームが自動付与(デフォルト)
  • 英数字、記号の「-」を使用して3~30文字以内で入力、先頭文字は英字のみを、末尾文字は英字または数字のみ使用
  • sourceVpcNo String Required Peeringリクエストを送る VPC番号
  • getVpcListを通じて確認
  • targetVpcNo String Required Peeringリクエストを受ける VPC番号
  • リクエストを受けるアカウントでgetVpcListを通じて確認
  • Peeringリクエストを送る VPCとリクエストを受ける VPCの IPv4 CIDRブロックが重なる場合、VPC Peeringで接続できない
  • targetVpcName String Conditional Peeringリクエストを受ける VPC名
  • Peeringリクエストを受けるアカウントが送るアカウントと異なる場合、リクエストを受ける VPCの名前を入力
  • targetVpcLoginId String Conditional Peeringリクエストを受ける VPC所有者 ID (メール形式)
  • リクエストを受けるアカウントが送るアカウントと異なる場合、リクエストを受けるアカウントを入力
  • vpcPeeringDescription String Optional 作成する VPC Peeringの説明 (Byte)
  • 0~1000
  • responseFormatType String Optional レスポンス結果の形式
    • xml(デフォルト) | json

    リクエスト例

    リクエストのサンプルコードは次の通りです。

    curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/createVpcPeeringInstance?regionCode=KR
    &vpcPeeringName=test-***
    &sourceVpcNo=***05
    &targetVpcNo=***06'
    --header 'x-ncp-apigw-timestamp: {Timestamp}'     
    --header 'x-ncp-iam-access-key: {Access Key}' 
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    レスポンス

    レスポンス形式を説明します。

    レスポンスボディ

    レスポンスボディの詳細は、VpcPeeringInstanceListをご参照ください。

    レスポンスステータスコード

    NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    <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>
          <lastModifyDate>2020-08-05T20:53:16+0900</lastModifyDate>
          <vpcPeeringInstanceStatus>
            <code>INIT</code>
            <codeName>init</codeName>
          </vpcPeeringInstanceStatus>
          <vpcPeeringInstanceStatusName>Creating</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>