getVpcPeeringInstanceList

Prev Next

VPC環境で利用できます。

概要

VPC Peeringインスタンスリストを照会します。

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制約事項 説明
regionCode No String リージョンコード
VPC Peeringインスタンスリストが照会されるリージョン(Region)を決定できます。
regionCodeはgetRegionListアクションを通じて取得できます。
Default：getRegionList照会結果の最初のリージョンを選択
vpcPeeringInstanceNoList.N No List<String> VPC Peeringインスタンス番号リスト
VPC Peeringインスタンス番号でフィルタリングして検索できます。
vpcPeeringInstanceNoはgetVpcPeeringInstanceListアクションを通じて取得できます。
ex)--vpcPeeringInstanceNoList 1234 2345
sourceVpcName No String リクエストVPC名
PeeringをリクエストしたVPC名でフィルタリングして検索できます。
targetVpcName No String 承諾VPC名
Peeringを承諾したVPC名でフィルタリングして検索できます。
vpcPeeringName No String VPC Peering名
VPC Peering名でフィルタリングして検索できます。
vpcPeeringInstanceStatusCode No String VPC Peeringインスタンスのステータスコード
VPC Peeringインスタンスのステータスコードでフィルタリングして検索できます。
Options : INIT | RUN | TERMTING
pageNo No Integer ページングされた結果のページ番号
結果値をpageNo、pageSizeを利用してページング処理できます。
pageSize Conditional Integer ページングする時に表示する各ページのサイズ
結果値をpageNo、pageSizeを利用してページング処理できます。
pageNoを入力する時に必ず入力しなければなりません。
sortedBy No String ソート対象
結果値をVPC Peering名、リクエストVPC名、承諾VPC名でソートできます。
Options : vpcPeeringName | sourceVpcName | targetVpcName
sortingOrder No String ソート順序
sortedByを利用する時、昇順/降順ソートを設定します。
Options：ASC (昇順) | DESC (降順)
Default : ASC
responseFormatType No String レスポンス結果のフォーマットタイプ
Options : xml | json
Default : xml

レスポンス

レスポンスデータタイプ

  • VpcPeeringInstanceListタイプ
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;

例

リクエスト例

ncloud vpc getVpcPeeringInstanceList --regionCode KR --vpcPeeringInstanceNoList ***6212 --sourceVpcName test-*** --targetVpcName test-*** --vpcPeeringName test-peering --vpcPeeringInstanceStatusCode RUN

レスポンス例

<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>
      <vpcPeeringInstanceStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </vpcPeeringInstanceStatus>
      <vpcPeeringInstanceStatusName>運用中</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>