getPublicIpInstanceList
- Print
- PDF
getPublicIpInstanceList
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
Gets a list of public IP instances.
Request
Request parameters
| Parameter | Required | Type | Limitations | Description |
|---|---|---|---|---|
| isAssociated | N | Boolean | Indicates whether it is associated. It indicates whether a public IP address is assigned or not. Options: true | false | |
| publicIpInstanceNoList.N | N | String | Duplicates not allowed. | List of public IP instance numbers to get Example) publicIpInstanceNoList.1=937520&publicIpInstanceNoList.2=932956 |
| publicIpList.N | N | List<String> | Min: 5, Max: 15 | List of public IP addresses to get Example) publicIpList.1=106.10.53.67 |
| searchFilterName | N | String | Filter name to search You can search public IP instances by publicIp and associatedServerName. Options: publicIp | associatedServerName [case insensitive]Map searchFilterName and searchFilterValue as follows. Example) searchFilterName=publicIp&searchFilterValue=106.10.53.67 Example) searchFilterName=associatedServerName&searchFilterValue=s1669aa4e78c | |
| searchFilterValue | N | String | Fileter value This value is mapped with searchFilterName. | |
| regionNo | N | String | Region number You can filter public IP instances by region. Get available values by using the getRegionList action. | |
| zoneNo | N | String | Zone number You can filter public IP instances by zone. Get available values by using the getZoneList action. All public IP addresses in the zone of the region will be selected if this parameter is not specified. | |
| pageNo | N | Integer | Min: 0, Max: 2147483647 | Page number of paginated results You can paginate results with pageNo. |
| pageSize | N | Integer | Min: 0, Max: 2147483647 | Page size to show when paginating results. You can paginate results with pageSize. |
| sortedBy | N | String | Sort by You can sort public IP instances by public IP or public IP instance number. Options: publicIp (Public IP) | publicIpInstanceNo (Public IP instance number) [case insensitive]Default: publicIpInstanceNo Map sortedBy and sortingOrder as follows. Example) sortedBy=publicIp&sortingOrder=ascending Example) sortedBy=publicIpInstanceNo&sortingOrder=descending | |
| sortingOrder | N | String | Sorting order It shows results sorted by the specified sortedBy value in ascending or descending order. ascending | descending [case insensitive]Default: ascending |
Response
Response body
Examples
Request example
GET {SERVER_API_URL}/getPublicIpInstanceList
?searchFilterName=associatedServerName
&searchFilterValue=s1669aa4e78c
Response example
<getPublicIpInstanceListResponse>
<requestId>9e27266d-049c-42c7-a04a-a884290dddb1</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<publicIpInstanceList>
<publicIpInstance>
<publicIpInstanceNo>1081432</publicIpInstanceNo>
<publicIp>106.10.46.237</publicIp>
<publicIpDescription></publicIpDescription>
<createDate>2018-11-23T18:33:45+0900</createDate>
<publicIpInstanceStatusName>used</publicIpInstanceStatusName>
<publicIpInstanceStatus>
<code>USED</code>
<codeName>NET USED state</codeName>
</publicIpInstanceStatus>
<publicIpInstanceOperation>
<code>NULL</code>
<codeName>NET NULL OP</codeName>
</publicIpInstanceOperation>
<publicIpKindType>
<code>GEN</code>
<codeName>General</codeName>
</publicIpKindType>
<serverInstanceAssociatedWithPublicIp>
<serverInstanceNo>1021003</serverInstanceNo>
<serverName>s1669aa4e78c</serverName>
<serverDescription>My server image copy error test</serverDescription>
<cpuCount>2</cpuCount>
<memorySize>4294967296</memorySize>
<baseBlockStorageSize>53687091200</baseBlockStorageSize>
<platformType>
<code>LNX64</code>
<codeName>Linux 64 Bit</codeName>
</platformType>
<loginKeyName>juhoon-kim</loginKeyName>
<isFeeChargingMonitoring>false</isFeeChargingMonitoring>
<publicIp>106.10.46.237</publicIp>
<privateIp>10.41.3.81</privateIp>
<serverImageName>tensorflow-centos-7.3-64</serverImageName>
<serverInstanceStatus>
<code>NSTOP</code>
<codeName>Server normal stopped state</codeName>
</serverInstanceStatus>
<serverInstanceOperation>
<code>NULL</code>
<codeName>Server NULL OP</codeName>
</serverInstanceOperation>
<serverInstanceStatusName>stopped</serverInstanceStatusName>
<createDate>2018-10-22T16:19:50+0900</createDate>
<uptime>2018-11-23T17:38:44+0900</uptime>
<serverImageProductCode>SPSW0LINUX000066</serverImageProductCode>
<serverProductCode>SPSVRSSD00000003</serverProductCode>
<isProtectServerTermination>false</isProtectServerTermination>
<portForwardingPublicIp>106.10.51.90</portForwardingPublicIp>
<zone>
<zoneNo>3</zoneNo>
<zoneName>KR-2</zoneName>
<zoneCode>KR-2</zoneCode>
<zoneDescription>Pyeongchon zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
<region>
<regionNo>1</regionNo>
<regionCode>KR</regionCode>
<regionName>Korea</regionName>
</region>
<baseBlockStorageDiskType>
<code>NET</code>
<codeName>Network Storage</codeName>
</baseBlockStorageDiskType>
<baseBlockStorageDiskDetailType>
<code>SSD</code>
<codeName>SSD</codeName>
</baseBlockStorageDiskDetailType>
<serverInstanceType>
<code>STAND</code>
<codeName>Standard</codeName>
</serverInstanceType>
<userData></userData>
<accessControlGroupList>
<accessControlGroup>
<accessControlGroupConfigurationNo>39995</accessControlGroupConfigurationNo>
<accessControlGroupName>ncloud-default-acg</accessControlGroupName>
<accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
<isDefault>true</isDefault>
<createDate>2018-04-09T11:12:54+0900</createDate>
</accessControlGroup>
</accessControlGroupList>
<instanceTagList/>
</serverInstanceAssociatedWithPublicIp>
<zone>
<zoneNo>3</zoneNo>
<zoneName>KR-2</zoneName>
<zoneCode>KR-2</zoneCode>
<zoneDescription>Pyeongchon zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
</publicIpInstance>
</publicIpInstanceList>
</getPublicIpInstanceListResponse>
Was this article helpful?