getNatGatewayInstanceList

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

概要

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

リクエスト

リクエストパラメータ

パラメータ名	要否	タイプ	説明
regionCode	No	String	- リージョンコード NAT Gatewayインスタンスのリストが照会されるリージョン(Region)を決定できる regionCodeは、getRegionListアクションを通じて取得できる Default: getRegionList照会結果の最初のリージョンを選択
zoneCode	No	String	- ZONEコード NAT Gatewayインスタンスのリストが照会されるゾーン(zone)を決定できる zoneCodeは、getZoneListアクションを通じて取得できる
natGatewayInstanceNoList.N	No	List<String>	- NAT Gatewayインスタンス番号のリスト NAT Gatewayインスタンス番号でフィルタリングして検索できる natGatewayInstanceNoは、getNatGatewayInstanceListアクションを通じて取得できる ex) --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インスタンスのステータスコードでフィルタリングして検索できる Options: INIT \| RUN \| TERMTING
pageNo	No	Integer	- ページングされた結果のページ番号結果値を pageNo、pageSizeを利用してページング処理できる
pageSize	Conditional	Integer	- ページング時に表示する各ページのサイズ結果値を pageNo、pageSizeを利用してページング処理できる pageNo入力時、必ず入力すること
responseFormatType	No	String	- レスポンス結果のフォーマットタイプ Options: xml \| json Default: xml
natGatewayType	No	String	- NAT Gatewayのタイプ Options: PRVT \| PBLIP
subnetName	No	String	- Subnet名
subnetNo	No	String	- Subnet番号
privateIp	No	String	- プライベート IPアドレス
publicIpInstanceNo	No	String	- グローバル IPアドレスインスタンス番号

レスポンス

レスポンスデータのタイプ

NatGatewayInstanceListのタイプ

NatGatewayInstanceList extends CommonResponse
private Integer totalRows;
private List natGatewayInstanceList = new ArrayList<>();

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;

例

リクエスト例

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

レスポンス例

<getNatGatewayInstanceListResponse>
  <requestId>7d68eb6c-6015-45d1-8711-e5e65d3704c6</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <natGatewayInstanceList>
    <natGatewayInstance>
      <vpcNo>***36</vpcNo>
      <vpcName>test-vpc</vpcName>
      <natGatewayInstanceNo>***9734</natGatewayInstanceNo>
      <natGatewayName>test-***</natGatewayName>
      <publicIp>***.***.109.101</publicIp>
      <natGatewayInstanceStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </natGatewayInstanceStatus>
      <natGatewayInstanceStatusName>Running</natGatewayInstanceStatusName>
      <natGatewayInstanceOperation>
         <code>NULL</code>
         <codeName>NULL OP</codeName>
      </natGatewayInstanceOperation>
      <createDate>2023-04-18T15:13:27+0900</createDate>
      <natGatewayDescription></natGatewayDescription>
      <zoneCode>KR-1</zoneCode>
      <natGatewayType>
         <code>PBLIP</code>
         <codeName>Public</codeName>
      </natGatewayType>
      <subnetName>v-kr1-pub-natgw-***</subnetName>
      <subnetNo>***28</subnetNo>
      <privateIp>10.0.***.***</privateIp>
      <publicIpInstanceNo>***25</publicIpInstanceNo>
    </natGatewayInstance>
  </natGatewayInstanceList>
</getNatGatewayInstanceListResponse>

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

What's Next

getNatGatewayInstanceDetail

概要
リクエスト
レスポンス
例

タグ