getNatGatewayInstanceList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

View the list of NAT Gateway instances based on the conditions the user specifies.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
GET, POST	/getNatGatewayInstanceList

Request headers

For headers common to all VPC APIs, see VPC common headers.

Request query parameters

The following describes the parameters.

Field	Type	Required	Description
`regionCode`	String	Optional	Region code whose network ACL instance list you want to view First Region of the search result (default) Check through getRegionList
`zoneCode`	String	Optional	Zone code whose NAT Gateway instance list you want to view Check through getZoneList
`natGatewayInstanceNoList.N`	List<String>	Optional	View with the NAT Gateway instance number `natGatewayInstanceNo` can be obtained through getNatGatewayInstanceList <E.g.> natGatewayInstanceNoList.1=1234&natGatewayInstanceNoList.2=2345
`publicIp`	String	Optional	View with the public IP address assigned to the NAT Gateway
`vpcName`	String	Optional	View with the VPC name
`natGatewayName`	String	Optional	View with the NAT Gateway name
`natGatewayInstanceStatusCode`	String	Optional	View with the NAT Gateway instance status code `INIT` \| `RUN` \| `TERMTING`
`pageNo`	Integer	Optional	Page number of the paged results Page the result values using `pageNo` and `pageSize`
	`pageSize`	Integer	Conditional
`responseFormatType`	String	Optional	Response result format `xml` (default) \| `json`
`subnetName`	String	Optional	View with the subnet name
`privateIp`	String	Optional	View with the private IP address
`natGatewayTypeCode`	CommonCode	Optional	View with the NAT Gateway type `PRVT` \| `PBLIP` `PRVT`: private NAT Gateway `PBLIP`: public NAT Gateway
`subnetNo`	String	Optional	View with the subnet number

Request example

The following is a sample request.

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}'

Response

The following describes the response format.

Response body

See NatGatewayInstanceList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

<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>

Was this article helpful?

What's Next

getNatGatewayInstanceDetail

Table of contents

Request
Response