getPublicIpInstanceList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Can be used in a VPC environment.

Overview

Query the list of Public IP instances.

Request

Request parameter

Parameter Name	Required Status	Type	Description
regionCode	No	String	Region Code You can decide the region where the list of Public IP instances will be queried. The regionCode can be obtained through the getRegionList action. Default: Select the first region of the getRegionList query results.
publicIpInstanceNoList.N	No	List<String>	List of the Public IP instance numbers You can search by filtering with the Public IP instance number. The publicIpInstanceNo can be obtained through the getPublicIpInstanceList action. ex) --publicIpInstanceNoList 1234 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 the Public IP instance is assigned.
isAssociated	No	Boolean	Allocation status You can search by filtering with the Public IP assigned to the server instance and the Public IP that is not assigned. Options : true \| false
serverName	No	String	Server name You can search by filtering with the server name where the Public IP instance is assigned.
publicIpInstanceStatusCode	No	String	Status code of the Public IP instance You can search by filtering with the status code of Public IP instance. Options : INIT \| SET \| RUN \| TERMTING
pageNo	No	Integer	The page number of the paged results The results can shown as pages using pageNo and pageSize.
pageSize	Conditional	Integer	The size of each page to be displayed at the time of paging The results can shown as pages using pageNo and pageSize. Enter it when entering pageNo.
vpcNo	No	String	VPC number You can search by filtering with the VPC number. vpcNo can be obtained through the getVpcList action.
responseFormatType	No	String	Format type for the response result Options : xml \| json Default : xml

Response

Response data type

PublicIpInstanceList type

PublicIpInstanceList extends CommonResponse
private Integer totalRows;
private List<PublicIpInstance> publicIpInstanceList = new ArrayList<>();

PublicIpInstance
private String publicIpInstanceNo;
private String publicIp;
private String publicIpDescription;
private Date createDate;
private String publicIpInstanceStatusName;
private CommonCode publicIpInstanceStatus;
private String serverInstanceNo;
private String serverName;
private String privateIp;
private Date lastModifyDate;
private CommonCode publicIpInstanceOperation;

Example

Request example

ncloud vserver getPublicIpInstanceList --regionCode KR --publicIpInstanceNoList ***7551 ***7552 --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>

Was this article helpful?

What's Next

getPublicIpInstanceDetail

Table of contents

Overview
Request
Response
Example