getNatGatewayInstanceList
- Print
- PDF
getNatGatewayInstanceList
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Available in VPC
Overview
It searches for the list of NAT gateway instances.
Requests
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | - Region code Can decide the Region in which the list of NAT Gateway instances is searched. regionCode can be obtained via the getRegionList action. Default: selects the first Region of the getRegionList query results | |
| zoneCode | No | String | - Zone code Enable to determine the zone in which the list of NAT Gateway instances is searched. zoneCode can be obtained via the getZoneListaction. | |
| natGatewayInstanceNoList.N | No | List<String> | - List of the NAT Gateway instance numbers Searchable by filtering with a NAT Gateway instance number natGatewayInstanceNo can be obtained via the getNatGatewayInstanceListaction. ex) natGatewayInstanceNoList.1=1234&natGatewayInstanceNoList.2=2345 | |
| publicIp | No | String | - Public IP Address Searchable by filtering by public IP address assigned to NAT Gateway | |
| vpcName | No | String | - VPC name Searchable by filtering by VPC name | |
| natGatewayName | No | String | - NAT Gateway name Searchable by filtering by NAT Gateway name | |
| natGatewayInstanceStatusCode | No | String | - Status code of NAT Gateway instance Searchable by filtering by the status code of the NAT Gateway instance Options : INIT | RUN | TERMTING | |
| pageNo | No | Integer | - Page number of paged result Paging can be handled using pageNo and pageSize | |
| pageSize | Conditional | Integer | - Size of each page to be displayed when paging Paging can be handled using pageNo and pageSize Must be entered when using pageNo | |
| responseFormatType | No | String | - Format type of the response result Options : xml | json Default : xml | |
| subnetName | No | String | - Subnet name | |
| privateIp | No | String | - Private IP | |
| natGatewayTypeCode | No | CommonCode | - NAT Gateway typePRVT (Private NAT Gateway)PBLIP (Public NAT Gateway) | |
| subnetNo | No | String | - Subnet number |
Responses
Response bodies
Examples
Request examples
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
Response examples
<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?