getPublicIpTargetServerInstanceList

Article Summary

Share feedback

Thanks for sharing your feedback!

Overview

Searching a list of server instances which are (can be) associated with public IP

Description

Search a list of server instances which are (can be) associated with publis IP.

Request Parameters

Parameter Name	Requiredness	Type	Limitation	Description
regionNo	No	String		You can reach a state in which input is possible by calling getRegionList.
zoneNo	No	String		You can get server instnace if you configure filters of Zone No. It can be obtained by using the getZoneList action. Default: Select the first zone of the region.

Response Data Type

ServerInstanceList type

ServerInstanceList extends CommonResponse
private Integer totalRows;
private List serverInstanceList = new ArrayList();

ServerInstance
private String serverInstanceNo;
private String serverName;
private String serverDescription;
private Integer cpuCount;
private Long memorySize;
private Long baseBlockStorageSize;
private CommonCode platformType;
private String loginKeyName;
private Boolean isFeeChargingMonitoring;
private String publicIp;
private String privateIp;
private String serverImageName;
private CommonCode serverInstanceStatus;
private CommonCode serverInstanceOperation;
private String serverInstanceStatusName;
private Date createDate;
private Date uptime;
private String serverImageProductCode;
private String serverProductCode;
private Boolean isProtectServerTermination;
private String portForwardingPublicIp;
private Integer portForwardingExternalPort;
private Integer portForwardingInternalPort;
private Zone zone;
private Region region;
private CommonCode baseBlockStorageDiskType;
private CommonCode baseBlockStorageDiskDetailType;
private CommonCode serverInstanceType
private String userData;
private List accessControlGroupList;
private List instanceTagList;
private List blockDevicePartitionList;

Examples

Request

ncloud server getPublicIpTargetServerInstanceList --regionNo 2

Response

{
  "getPublicIpTargetServerInstanceListResponse": {
    "requestId": "f14a85cf-d4f7-4469-81fe-172077cff69d",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 2,
    "serverInstanceList": [
      {
        "serverInstanceNo": "394180",
        "serverName": "mssong-test",
        "serverDescription": "",
        "cpuCount": 2,
        "memorySize": 4294967296,
        "baseBlockStorageSize": 53687091200,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "redis-web",
        "isFeeChargingMonitoring": false,
        "publicIp": "",
        "privateIp": "10.113.201.150",
        "serverImageName": "centos-6.3-64",
        "serverInstanceStatus": {
          "code": "NSTOP",
          "codeName": "Server normal stopped state"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "Server NULL OP"
        },
        "serverInstanceStatusName": "stopped",
        "createDate": "2017-12-27T23:56:58+0900",
        "uptime": "2017-12-28T00:03:58+0900",
        "serverImageProductCode": "SPSW0LINUX000031",
        "serverProductCode": "SPSVRSTAND000004",
        "isProtectServerTermination": false,
        "portForwardingPublicIp": "192.168.10.100",
        "zone": {
          "zoneNo": "10",
          "zoneName": "USW-1",
          "zoneDescription": "1st zone"
        },
        "region": {
          "regionNo": "2",
          "regionCode": "USW",
          "regionName": "US-West"
        },
        "baseBlockStorageDiskType": {
          "code": "NET",
          "codeName": "Network Storage"
        },
        "baseBlockStroageDiskDetailType": {
          "code": "HDD",
          "codeName": "HDD"
        },
        "userData": "",
        "accessControlGroupList": [
          {
            "accessControlGroupConfigurationNo": "1038",
            "accessControlGroupName": "ncloud-default-acg",
            "accessControlGroupDescription": "Default AccessControlGroup",
            "isDefault": true,
            "createDate": "2013-12-03T10:37:39+0900"
          }
        ],
        "instanceTagList" : []
      },
      {
        "serverInstanceNo": "394148",
        "serverName": "svr-9bbaf123363a00f",
        "serverDescription": "",
        "cpuCount": 2,
        "memorySize": 4294967296,
        "baseBlockStorageSize": 53687091200,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "redis-web",
        "isFeeChargingMonitoring": false,
        "publicIp": "",
        "privateIp": "10.113.201.151",
        "serverImageName": "centos-6.6-64",
        "serverInstanceStatus": {
          "code": "RUN",
          "codeName": "Server RUN State"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "Server NULL OP"
        },
        "serverInstanceStatusName": "running",
        "createDate": "2017-12-27T21:18:40+0900",
        "uptime": "2017-12-27T21:26:12+0900",
        "serverImageProductCode": "SPSW0LINUX000044",
        "serverProductCode": "SPSVRSTAND000004",
        "isProtectServerTermination": false,
        "portForwardingPublicIp": "192.168.10.100",
        "zone": {
          "zoneNo": "10",
          "zoneName": "USW-1",
          "zoneDescription": "1st zone"
        },
        "region": {
          "regionNo": "2",
          "regionCode": "USW",
          "regionName": "US-West"
        },
        "baseBlockStorageDiskType": {
          "code": "NET",
          "codeName": "Network Storage"
        },
        "baseBlockStroageDiskDetailType": {
          "code": "HDD",
          "codeName": "HDD"
        },
        "userData": "",
        "initScriptNo": "",
        "accessControlGroupList": [
          {
            "accessControlGroupConfigurationNo": "1038",
            "accessControlGroupName": "ncloud-default-acg",
            "accessControlGroupDescription": "Default AccessControlGroup",
            "isDefault": true,
            "createDate": "2013-12-03T10:37:39+0900"
          }
        ],
        "instanceTagList" : []
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<getPublicIpTargetServerInstanceListResponse>
  <requestId>f14a85cf-d4f7-4469-81fe-172077cff69d</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>2</totalRows>
  <serverInstanceList>
    <serverInstanceNo>394180</serverInstanceNo>
    <serverName>mssong-test</serverName>
    <serverDescription></serverDescription>
    <cpuCount>2</cpuCount>
    <memorySize>4294967296</memorySize>
    <baseBlockStorageSize>53687091200</baseBlockStorageSize>
    <platformType>
      <code>LNX64</code>
      <codeName>Linux 64 Bit</codeName>
    </platformType>
    <loginKeyName>redis-web</loginKeyName>
    <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
    <publicIp></publicIp>
    <privateIp>10.113.201.150</privateIp>
    <serverImageName>centos-6.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>2017-12-27T23:56:58+0900</createDate>
    <uptime>2017-12-28T00:03:58+0900</uptime>
    <serverImageProductCode>SPSW0LINUX000031</serverImageProductCode>
    <serverProductCode>SPSVRSTAND000004</serverProductCode>
    <isProtectServerTermination>false</isProtectServerTermination>
    <portForwardingPublicIp>192.168.10.100</portForwardingPublicIp>
    <zone>
      <zoneNo>10</zoneNo>
      <zoneName>USW-1</zoneName>
      <zoneDescription>1st zone</zoneDescription>
    </zone>
    <region>
      <regionNo>2</regionNo>
      <regionCode>USW</regionCode>
      <regionName>US-West</regionName>
    </region>
    <baseBlockStorageDiskType>
      <code>NET</code>
      <codeName>Network Storage</codeName>
    </baseBlockStorageDiskType>
    <baseBlockStroageDiskDetailType>
      <code>HDD</code>
      <codeName>HDD</codeName>
    </baseBlockStroageDiskDetailType>
    <userData></userData>
    <initScriptNo></initScriptNo>
    <accessControlGroupList>
      <accessControlGroupConfigurationNo>1038</accessControlGroupConfigurationNo>
      <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
      <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
      <isDefault>true</isDefault>
      <createDate>2013-12-03T10:37:39+0900</createDate>
    </accessControlGroupList>
    <instanceTagList/>
  </serverInstanceList>
  <serverInstanceList>
    <serverInstanceNo>394148</serverInstanceNo>
    <serverName>svr-9bbaf123363a00f</serverName>
    <serverDescription></serverDescription>
    <cpuCount>2</cpuCount>
    <memorySize>4294967296</memorySize>
    <baseBlockStorageSize>53687091200</baseBlockStorageSize>
    <platformType>
      <code>LNX64</code>
      <codeName>Linux 64 Bit</codeName>
    </platformType>
    <loginKeyName>redis-web</loginKeyName>
    <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
    <publicIp></publicIp>
    <privateIp>10.113.201.151</privateIp>
    <serverImageName>centos-6.6-64</serverImageName>
    <serverInstanceStatus>
      <code>RUN</code>
      <codeName>Server RUN State</codeName>
    </serverInstanceStatus>
    <serverInstanceOperation>
      <code>NULL</code>
      <codeName>Server NULL OP</codeName>
    </serverInstanceOperation>
    <serverInstanceStatusName>running</serverInstanceStatusName>
    <createDate>2017-12-27T21:18:40+0900</createDate>
    <uptime>2017-12-27T21:26:12+0900</uptime>
    <serverImageProductCode>SPSW0LINUX000044</serverImageProductCode>
    <serverProductCode>SPSVRSTAND000004</serverProductCode>
    <isProtectServerTermination>false</isProtectServerTermination>
    <portForwardingPublicIp>192.168.10.100</portForwardingPublicIp>
    <zone>
      <zoneNo>10</zoneNo>
      <zoneName>USW-1</zoneName>
      <zoneDescription>1st zone</zoneDescription>
    </zone>
    <region>
      <regionNo>2</regionNo>
      <regionCode>USW</regionCode>
      <regionName>US-West</regionName>
    </region>
    <baseBlockStorageDiskType>
      <code>NET</code>
      <codeName>Network Storage</codeName>
    </baseBlockStorageDiskType>
    <baseBlockStroageDiskDetailType>
      <code>HDD</code>
      <codeName>HDD</codeName>
    </baseBlockStroageDiskDetailType>
    <userData></userData>
    <initScriptNo></initScriptNo>
    <accessControlGroupList>
      <accessControlGroupConfigurationNo>1038</accessControlGroupConfigurationNo>
      <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
      <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
      <isDefault>true</isDefault>
      <createDate>2013-12-03T10:37:39+0900</createDate>
    </accessControlGroupList>
    <instanceTagList/>
  </serverInstanceList>
</getPublicIpTargetServerInstanceListResponse>

Was this article helpful?

What's Next

createPublicIpInstance

Table of contents

Overview
Description
Request Parameters
Response Data Type
Examples