getPublicIpInstanceList

Prev Next

Can be used in a VPC environment.

Overview

This searches a list of public IP instances.

Request

Request parameters

Parameter name Required Type Restrictions Description
regionCode No String Region code
You can decide the region in which the public IP instance list will be queried.
regionCode can be obtained through the getRegionList action.
Default: Select the first region of the getRegionList search results
publicIpInstanceNoList.N No List<String> List of public IP instance numbers
You can search by filtering with a public IP instance number.
publicIpInstanceNo can be obtained through the getPublicIpInstanceList action.
ex) publicIpInstanceNoList.1=1234&publicIpInstanceNoList.2=2345
publicIp No String Public IP Address
You can search by filtering with a public IP address.
privateIp No String Private IP Address
You can search by filtering with the eth0 private IP address of the server instance to which a public IP instance is assigned.
isAssociated No Boolean Allotment status
You can search by filtering with the public IP assigned and unassigned to a server instance.
Options : true | false
serverName No String Server name
You can search by filtering with the server name in which a public IP instance is assigned.
publicIpInstanceStatusCode No String Public IP instance status code
You can search by filtering with the status code of a public IP instance.
Options : INIT | SET | RUN | TERMTING
pageNo No Integer Page number of the paged results
The results can be paged using pageNo and pageSize.
pageSize Conditional Integer Each page size to be displayed when paging
The results can be paged using pageNo and pageSize.
It must be entered when entering pageNo.
vpcNo No String VPC number
You can search by filtering with a VPC number.
vpcNo can be obtained through the getVpcList action.
responseFormatType No String Format type of the response results
Options : xml | json
Default : xml

Response

Response body

Example

Request Example

GET {API_URL}/getPublicIpInstanceList
?regionCode=KR
&publicIpInstanceNoList.1=***7551
&publicIp=***.***.111.215
&privateIp=***.***.1.6
&isAssociated=true
&serverName=test-***
&publicIpInstanceStatusCode=RUN
&vpcNo=***04

Response Example

<getPublicIpInstanceListResponse>
  <requestId>ff28f839-00f2-4d07-bd6b-b172596eebf8</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <publicIpInstanceList>
    <publicIpInstance>
      <publicIpInstanceNo>***7551</publicIpInstanceNo>
      <publicIp>***.***.111.215</publicIp>
      <publicIpDescription></publicIpDescription>
      <createDate>2020-08-19T14:34:41+0900</createDate>
      <publicIpInstanceStatusName>Running</publicIpInstanceStatusName>
      <publicIpInstanceStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </publicIpInstanceStatus>
      <serverInstanceNo>***4299</serverInstanceNo>
      <serverName>test-***</serverName>
      <privateIp>***.***.1.6</privateIp>
      <publicIpInstanceOperation>
        <code>NULL</code>
        <codeName>NULL OP</codeName>
      </publicIpInstanceOperation>
    </publicIpInstance>
  </publicIpInstanceList>
</getPublicIpInstanceListResponse>