getNatGatewayInstanceList

Prev Next

VPC環境で利用できます。

概要

NAT Gatewayインスタンスリストを照会します。

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制限事項 説明
regionCode No String リージョンコード
  • NAT Gatewayンスタンスリスト照会対象のリージョン(Region)を決定可能
  • regionCodeはgetRegionListアクションを通じて取得可能
  • デフォルト: getRegionList照会結果の最初のリージョンを選択
zoneCode No String ZONEコード
  • NAT Gatewayインスタンスリスト照会対象のゾーン(zone)を決定可能
  • zoneCodeはgetZoneListアクションを通じて取得可能
natGatewayInstanceNoList.N No List<String> NAT Gatewayインスタンス番号リスト
  • NAT Gatewayインスタンス番号で絞り込んで検索可能
  • natGatewayInstanceNoはgetNatGatewayInstanceListアクションを通じて取得可能
  • 例) --natGatewayInstanceNoList 1234 2345
publicIp No String グローバル IPアドレス
  • NAT Gatewayに割り当てられたグローバル IPアドレスで絞り込んで検索可能
vpcName No String VPC名
  • VPC名で絞り込んで検索可能
natGatewayName No String NAT Gateway名
  • NAT Gateway名で絞り込んで検索可能
natGatewayInstanceStatusCode No String NAT Gatewayインスタンスの状態コード
  • NAT Gatewayインスタンスの状態コードで絞り込んで検索可能
  • オプション: INIT | RUN | SET | TERMTING
pageNo No Integer ページングされた結果のページ番号
  • 結果値を pageNo、pageSizeを利用してページング処理可能
pageSize Conditional Integer ページング時に表示する各ページサイズ
  • 結果値を pageNo、pageSizeを利用してページング処理可能
  • pageNo入力時、必ず入力
output No String レスポンス結果の形式タイプ
  • オプション: xml | json
  • デフォルト: json
natGatewayTypeCode No String NAT Gatewayタイプ
  • オプション: PRVT | PBLIP
subnetName No String Subnet名
subnetNo No String Subnet番号
privateIp No String プライベート IPアドレス
publicIpInstanceNo No String Public IPアドレスのインスタンス番号

レスポンス

レスポンスデータタイプ

NatGatewayInstanceList extends CommonResponse
private Integer totalRows;
private List<NatGatewayInstance> natGatewayInstanceList
NatGatewayInstance
private String vpcNo;
private String vpcName;
private String natGatewayInstanceNo;
private String natGatewayName;
private String publicIp;
private CommonCode natGatewayInstanceStatus;
private String natGatewayInstanceStatusName;
private CommonCode natGatewayInstanceOperation;
private Date createDate;
private String natGatewayDescription;
private String zoneCode;
private CommonCode natGatewayType;
private String subnetName;
private String subnetNo;
private String privateIp;
private String publicIpInstanceNo;
private List<NatGatewayIp> natGatewayIpList;
NatGatewayIp
private String type;
private String privateIp;
private String publicIp;
private String publicIpInstanceNo;

例

リクエスト例

ncloud vpc getNatGatewayInstanceList --regionCode KR --zoneCode KR-1 --natGatewayInstanceNoList ***9734 --publicIp ***.***.109.101 --vpcName test-vpc --natGatewayName test-*** --natGatewayInstanceStatusCode RUN  --natGatewayTypeCode PBLIP

レスポンス例

<getNatGatewayInstanceListResponse>
  <requestId>09b86d75-4a0b-4148-ab7f-5412d15bcb22</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <natGatewayInstanceList>
    <natGatewayInstance>
      <vpcNo>***36</vpcNo>
      <vpcName>normal-***</vpcName>
      <natGatewayInstanceNo>*****9288</natGatewayInstanceNo>
      <natGatewayName>public-***</natGatewayName>
      <publicIp>***.***.153.178</publicIp>
      <natGatewayInstanceStatus>
        <code>RUN</code>
        <codeName>RUN状態</codeName>
      </natGatewayInstanceStatus>
      <natGatewayInstanceStatusName>Running</natGatewayInstanceStatusName>
      <natGatewayInstanceOperation>
        <code>NULL</code>
        <codeName>NULL OP</codeName>
      </natGatewayInstanceOperation>
      <createDate>2025-04-25T14:19:32+0900</createDate>
      <natGatewayDescription>description</natGatewayDescription>
      <zoneCode>KR-1</zoneCode>
      <natGatewayType>
        <code>PBLIP</code>
        <codeName>グローバル</codeName>
      </natGatewayType>
      <subnetName>public-***</subnetName>
      <subnetNo>***29</subnetNo>
      <privateIp>10.0.1.6</privateIp>
      <publicIpInstanceNo>****290</publicIpInstanceNo>
      <natGatewayIpList>
        <natGatewayIp>
          <type>PRIMARY</type>
          <privateIp>10.0.1.6</privateIp>
          <publicIp>***.***.153.178</publicIp>
          <publicIpInstanceNo>****290</publicIpInstanceNo>
        </natGatewayIp>
        <natGatewayIp>
          <type>SECONDARY</type>
          <privateIp>10.0.1.7</privateIp>
          <publicIp>***.***.109.24</publicIp>
          <publicIpInstanceNo>****805</publicIpInstanceNo>
        </natGatewayIp>
      </natGatewayIpList>
    </natGatewayInstance>
  </natGatewayInstanceList>
</getNatGatewayInstanceListResponse>