getNatGatewayInstanceList

印刷する
共有
PDF

記事の要約

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

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

VPC環境で利用できます。

ユーザーが指定した条件に基づいて NAT Gatewayインスタンスリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET、POST	/getNatGatewayInstanceList

リクエストヘッダ

VPC APIで共通して使用されるヘッダの詳細は、VPCの共通ヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	Network ACLインスタンスリストを照会する対象のリージョンコード照会結果の最初のリージョン(デフォルト) getRegionListを通じて確認
`zoneCode`	String	Optional	NAT Gatewayインスタンスリスト照会対象のゾーンコード getZoneListを通じて確認
`natGatewayInstanceNoList.N`	List<String>	Optional	NAT Gatewayインスタンス番号で照会 `natGatewayInstanceNo`はgetNatGatewayInstanceListを通じて確認 <例> natGatewayInstanceNoList.1=1234&natGatewayInstanceNoList.2=2345
`publicIp`	String	Optional	NAT Gatewayに割り当てられたグローバル IPアドレスで照会
`vpcName`	String	Optional	VPC名で照会
`natGatewayName`	String	Optional	NAT Gateway名で照会
`natGatewayInstanceStatusCode`	String	Optional	NAT Gatewayインスタンスの状態コードで照会 `INIT` \| `RUN` \| `TERMTING`
`pageNo`	Integer	Optional	ページングされた結果のページ番号 `pageNo`、`pageSize`を利用して結果値をページング処理
	`pageSize`	Integer	Conditional
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`
`subnetName`	String	Optional	Subnet名で照会
`privateIp`	String	Optional	プライベート IPアドレスで照会
`natGatewayTypeCode`	CommonCode	Optional	NAT Gatewayタイプで照会 `PRVT` \| `PBLIP` `PRVT`: Private NAT Gateway `PBLIP`: Public NAT Gateway
`subnetNo`	String	Optional	Subnet番号で照会

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/getNatGatewayInstanceList
?regionCode=KR
&zoneCode=KR-1
&natGatewayInstanceNoList.1=***9734
&publicIp=***.***.109.101
&vpcName=test-vpc
&natGatewayName=test-***
&natGatewayInstanceStatusCode=RUN
&natGatewayTypeCode=PBLIP'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、NatGatewayInstanceListをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

<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

リクエスト
レスポンス

タグ