getVpcPeeringInstanceDetail

Prev Next

VPC環境で利用できます。

VPC Peeringインスタンス番号を指定して VPC Peeringインスタンスの詳細情報を照会します。

リクエスト

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

メソッド URI
GET, POST /getVpcPeeringInstanceDetail

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional VPC Peeringインスタンス詳細情報照会対象のリージョンコード
  • 照会結果の最初のリージョン(デフォルト)
  • getRegionListを通じて確認
    		•
    vpcPeeringInstanceNo String Required 詳細情報照会対象 VPC Peeringのインスタンス番号
  • getVpcPeeringInstanceListアクションを通じて取得可能
    		•
    responseFormatType String Optional レスポンス結果の形式
    • xml(デフォルト) | json

    リクエスト例

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

    curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/getVpcPeeringInstanceDetail
?regionCode=KR
&vpcPeeringInstanceNo=***6212'
--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のレスポンスステータスコードをご参照ください。

    レスポンス例

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

    <getVpcPeeringInstanceDetailResponse>
 <requestId>a119cd5c-9434-4019-b0e8-f253b781614a</requestId>
 <returnCode>0</returnCode>
 <returnMessage>success</returnMessage>
 <totalRows>1</totalRows>
 <vpcPeeringInstanceList>
   <vpcPeeringInstance>
     <vpcPeeringInstanceNo>***6212</vpcPeeringInstanceNo>
     <vpcPeeringName>test-***</vpcPeeringName>
     <regionCode>KR</regionCode>
     <createDate>2020-08-05T20:53:16+0900</createDate>
     <lastModifyDate>2020-08-05T20:53:16+0900</lastModifyDate>
     <vpcPeeringInstanceStatus>
       <code>RUN</code>
       <codeName>run</codeName>
     </vpcPeeringInstanceStatus>
     <vpcPeeringInstanceStatusName>Running</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>
</getVpcPeeringInstanceDetailResponse>