getPublicIpInstanceDetail

Prev Next

Can be used in a VPC environment.

Overview

Query the Public IP instance details using the Public IP instance number.

Request

Request parameter

Parameter Name Required Status Type Restrictions Description
regionCode No String Region Code
You can decide the region where the Public IP instance details will be queried.
The regionCode can be obtained through the getRegionList action.
Default: Select the first region of the getRegionList query results.
publicIpInstanceNo Yes String The number of the Public IP instance to be queried
The publicIpInstanceNo can be obtained through the getPublicIpInstanceList 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 getPublicIpInstanceDetail --regionCode KR --publicIpInstanceNo ***7551

Response example

<getPublicIpInstanceDetailResponse>
  <requestId>d9a37d96-eaca-41e0-9878-ffb3085b77ca</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>
</getPublicIpInstanceDetailResponse>