Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getNatGatewayInstanceDetail

Prev Next

VPC環境で利用できます。

概要

NAT Gatewayインスタンス番号を利用して NAT Gatewayインスタンスの詳細情報を照会します。

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制限事項 説明
regionCode No String リージョンコード
  • NAT Gatewayインスタンスの詳細情報照会対象のリージョン(Region)を決定可能
  • regionCodeはgetRegionListアクションを通じて取得可能
  • デフォルト: getRegionList照会結果の最初のリージョンを選択
natGatewayInstanceNo Yes String 照会対象の NAT Gatewayインスタンス番号
responseFormatType No String レスポンス結果の形式タイプ
  • オプション: xml | json
  • デフォルト: xml

レスポンス

レスポンスデータタイプ

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 getNatGatewayInstanceDetail --regionCode KR --natGatewayInstanceNo ***9734

レスポンス例

<getNatGatewayInstanceDetailResponse>
  <requestId>0dfdd686-a6c4-4c7e-91b8-ac0a2193fd32</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>
</getNatGatewayInstanceDetailResponse>