Overview
Get the list of public IP instances.
Request
Request parameters
| Parameter name | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| isAssociated | No | Boolean | - Assignment status You can query assigned public IPs and unassigned public IPs. Options: true | false |
|
| publicIpInstanceNoList.N | No | String | It can't be duplicated. | - List of public IP instance numbers to query e.g., publicIpInstanceNoList.1=937520&publicIpInstanceNoList.2=932956 |
| publicIpList.N | No | List<String> | Min: 5, Max: 15 | - Public IP list to query e.g., publicIpList.1=106.10.53.67 |
| searchFilterName | No | String | - Name of filter to search Search by filtering by public IP (publicIp) and assigned server name (associatedServerName). Options: publicIp | associatedServerName [case-insensitive] searchFilterName is used by mapping with the searchFilterValue value shown below. e.g., searchFilterName=publicIp&searchFilterValue=106.10.53.67 e.g., searchFilterName=associatedServerName&searchFilterValue=s1669aa4e78c |
|
| searchFilterValue | No | String | - Filter value to search for Enter the value to be mapped to the searchFilterName value shown above. |
|
| regionNo | No | String | - Region number The list of public IP instances can be filtered using Region. regionNo can be obtained through the getRegionList action. |
|
| zoneNo | No | String | - Zone number The list of public IP instances can be filtered using zone. zoneNo can be obtained through the getZoneList action. If no filter is set, the list of all public IP addresses belonging to the zone of the Region is selected. |
|
| pageNo | No | Integer | Min: 0, Max: 2147483647 |
- Page number of the paged results The results can be paged using pageNo. |
| pageSize | No | Integer | Min: 0, Max: 2147483647 |
- Size of each page to be displayed when paging The results can be paged using pageSize. |
| sortedBy | No | String | - Sorted by Sort by public IP and public IP instance number. Options: publicIp (public IP) | publicIpInstanceNo (public IP instance number) [case-insensitive] Default: publicIpInstanceNo sortedBy is used by mapping with the sortingOrder shown below. e.g., sortedBy=publicIp&sortingOrder=ascending e.g., sortedBy=publicIpInstanceNo&sortingOrder=descending |
|
| sortingOrder | No | String | - Sorting order Set the ascending/descending sort order of sortedBy set above. ascending | descending [case-insensitive] Default: ascending |
|
| responseFormatType | No | String | - Format type of the response result Options: xml | json Default: xml |
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>