getNatGatewayInstanceList

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

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.1=1234&natGatewayInstanceNoList.2=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
subnetName	No	String	- Subnet名
privateIp	No	String	- プライベート IPアドレス
natGatewayTypeCode	No	CommonCode	- NAT Gatewayタイプ `PRVT (Private NAT Gateway)` `PBLIP (Public NAT Gateway)`
subnetNo	No	String	- Subnet番号

レスポンス

レスポンスボディ

NatGatewayInstanceList

例

リクエスト例

GET {API_URL}/vpc/v2/getNatGatewayInstanceList
?regionCode=KR
&zoneCode=KR-1
&natGatewayInstanceNoList.1=***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

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

タグ