getVpcPeeringInstanceList
    • PDF

    getVpcPeeringInstanceList

    • PDF

    記事の要約

    VPC環境で利用できます。

    指定した条件に基づいて VPC Peeringインスタンスリストを照会します。

    リクエスト

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

    メソッドURI
    GET、POST/getVpcPeeringInstanceList

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    regionCodeStringOptionalVPC Peeringインスタンスリスト照会対象のリージョンコード
  • 照会結果の最初のリージョン(デフォルト)
  • getRegionListを通じて確認
  • vpcPeeringInstanceNoList.NList<String>OptionalVPC Peeringインスタンス番号で照会
  • vpcPeeringInstanceNogetVpcPeeringInstanceListを通じて確認
  • <例>vpcPeeringInstanceNoList.1=1234&vpcPeeringInstanceNoList.2=2345
  • sourceVpcNameStringOptionalPeeringをリクエストした VPC名で照会
    targetVpcNameStringOptionalPeeringを承諾した VPC名で照会
    vpcPeeringNameStringOptionalVPC Peering名で照会
    vpcPeeringInstanceStatusCodeStringOptionalVPC Peeringインスタンスの状態コードで照会
    • INIT | RUN | TERMTING
      • INIT: 承諾待ち中
      • RUN: 運用中
      • TERMTING: 終了中
    pageNoIntegerOptionalページングされた結果のページ番号
    • pageNopageSizeを利用して結果値をページング処理
    pageSizeIntegerConditional
    sortedByStringOptional照会結果のソート基準
    • vpcPeeringName | sourceVpcName | targetVpcName
      • vpcPeeringName: VPC Peering名
      • sourceVpcName: リクエスト VPC名
      • targetVpcName: 承諾 VPC名
    sortingOrderStringOptionalsortedBy利用時の昇順または降順のソートを設定
    • ASC(デフォルト) | DESC
      • ASC: 昇順
      • DESC: 降順
    responseFormatTypeStringOptionalレスポンス結果の形式
    • xml(デフォルト) | json

    リクエスト例

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

    curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/getVpcPeeringInstanceList
    ?regionCode=KR
    &vpcPeeringInstanceNoList.1=***6212
    &sourceVpcName=test-***
    &targetVpcName=test-***
    &vpcPeeringName=test-peering
    &vpcPeeringInstanceStatusCode=RUN'
    --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のレスポンスステータスコードをご参照ください。

    レスポンス例

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

    <getVpcPeeringInstanceListResponse>
      <requestId>d0d25721-3f73-4b76-baf8-63232d5a8351</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>
    </getVpcPeeringInstanceListResponse>
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.