Overview

Finding a list of server instances available for load balancers

Description

Find a list of server instance which is available depending on the state of load balancer.

Request Parameters

Parameter Name	Requiredness	Type	Limitation	Description
networkUsageTypeCode		String		Network usage type code PBLIP(PublicIP) \| PRVT(PrivateIP) Default : PBLIP
regionNo	No	String		You can reach a state in which input is possible by calling getRegionList.

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 CommonCode baseBlockStorageDiskType;
private CommonCode baseBlockStorageDiskDetailType;
private CommonCode serverInstanceType
private String userData;
private List accessControlGroupList;
private List instanceTagList;

Examples

Request

ncloud loadbalancer getLoadBalancerTargetServerInstanceList --networkUsageTypeCode PBLIP

Response

{
  "getLoadBalancerTargetServerInstanceListResponse": {
    "requestId": "309c2bc3-c477-4dd1-91d9-924a19dbdad0",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 2,
    "serverInstanceList": [
    {
      "serverInstanceNo": 463086,
      "serverName": "penguin",
      "serverDescription": "",
      "cpuCount": 2,
      "memorySize": 2147483648,
      "baseBlockStorageSize": 53687091200,
      "platformType": {
        "code": "LNX64",
        "codeName": "Linux 64 Bit"
      },
      "loginKeyName": "ncloud",
      "isFeeChargingMonitoring": false,
      "publicIp": "",
      "privateIp": "10.39.3.139",
      "serverImageName": "centos-7.3-64",
      "serverInstanceStatus": {
        "code": "RUN",
        "codeName": "Server run state"
      },
      "serverInstanceOperation": {
        "code": "NULL",
        "codeName": "Server NULL OP"
      },
      "serverInstanceStatusName": "running",
      "createDate": "2017-12-04T16:26:54+0900",
      "uptime": "2017-12-04T17:33:16+0900",
      "serverImageProductCode": "SPSW0LINUX000046",
      "serverProductCode": "SPSVRSTAND000049",
      "isProtectServerTermination": false,
      "portForwardingPublicIp": "49.236.160.9",
      "zone": {
        "zoneNo": 2,
        "zoneName": "KR-1",
        "zoneDescription": "가산 NANG zone"
      },
      "region": {
        "regionNo": 1,
        "regionCode": "KR",
        "regionName": "Korea"
      },
      "baseBlockStorageDiskType": {
        "code": "NET",
        "codeName": "Network Storage"
      },
      "baseBlockStroageDiskDetailType": {
        "code": "HDD",
        "codeName": "HDD"
      },
      "userData": "",
      "accessControlGroupList": [
       {
           "accessControlGroupConfigurationNo": 17759,
           "accessControlGroupName": "ncloud-default-acg",
           "accessControlGroupDescription": "Default AccessControlGroup",
           "isDefault": true,
           "createDate": "2013-12-03T10:37:43+0900"
       }
       ]
    },
    {
      "serverInstanceNo": 460370,
      "serverName": "s-361oopnmo2nxoz001",
      "serverDescription": "Auto scaling group \u0027secu\u0027 소속의 자동 생성된 서버",
      "cpuCount": 2,
      "memorySize": 4294967296,
      "baseBlockStorageSize": 53687091200,
      "platformType": {
        "code": "LNX64",
        "codeName": "Linux 64 Bit"
      },
      "loginKeyName": "beta-20",
      "isFeeChargingMonitoring": false,
      "publicIp": "",
      "privateIp": "10.39.2.157",
      "serverImageName": "centos-7.3-64",
      "serverInstanceStatus": {
        "code": "RUN",
        "codeName": "Server run state"
      },
      "serverInstanceOperation": {
        "code": "NULL",
        "codeName": "Server NULL OP"
      },
      "serverInstanceStatusName": "running",
      "createDate": "2017-12-03T18:27:43+0900",
      "uptime": "2017-12-03T18:30:49+0900",
      "serverImageProductCode": "SPSW0LINUX000046",
      "serverProductCode": "SPSVRSTAND000004",
      "isProtectServerTermination": false,
      "portForwardingPublicIp": "49.236.160.9",
      "zone": {
        "zoneNo": 2,
        "zoneName": "KR-1",
        "zoneDescription": "가산 NANG zone"
      },
      "region": {
        "regionNo": 1,
        "regionCode": "KR",
        "regionName": "Korea"
      },
      "baseBlockStorageDiskType": {
        "code": "NET",
        "codeName": "Network Storage"
      },
      "baseBlockStroageDiskDetailType": {
        "code": "HDD",
        "codeName": "HDD"
      },
      "userData": "",
      "accessControlGroupList": [
      {
        "accessControlGroupConfigurationNo": 17759,
        "accessControlGroupName": "ncloud-default-acg",
        "accessControlGroupDescription": "Default AccessControlGroup",
        "isDefault": true,
        "createDate": "2013-12-03T10:37:43+0900"
      }
      ]
     }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<getLoadBalancerTargetServerInstanceListResponse>
  <requestId>71493679-3725-4565-8459-9c45e25fde68</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <serverInstanceList>
    <serverInstance>
      <serverInstanceNo>1289694</serverInstanceNo>
      <serverName>ncloud-mktest</serverName>
      <serverDescription></serverDescription>
      <cpuCount>1</cpuCount>
      <memorySize>2147483648</memorySize>
      <baseBlockStorageSize>53687091200</baseBlockStorageSize>
      <platformType>
        <code>LNX64</code>
        <codeName>Linux 64 Bit</codeName>
      </platformType>
      <loginKeyName>beagle</loginKeyName>
      <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
      <publicIp></publicIp>
      <privateIp>10.41.84.156</privateIp>
      <serverImageName>centos-7.3-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>2019-02-22T15:03:49+0900</createDate>
      <uptime>2019-02-22T15:07:30+0900</uptime>
      <serverImageProductCode>SPSW0LINUX000046</serverImageProductCode>
      <serverProductCode>SPSVRSTAND000003</serverProductCode>
      <isProtectServerTermination>false</isProtectServerTermination>
      <portForwardingPublicIp>106.10.59.225</portForwardingPublicIp>
      <zone>
        <zoneNo>3</zoneNo>
        <zoneName>KR-2</zoneName>
        <zoneCode>KR-2</zoneCode>
        <zoneDescription>평촌 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>HDD</code>
        <codeName>HDD</codeName>
      </baseBlockStorageDiskDetailType>
      <serverInstanceType>
        <code>COMPT</code>
        <codeName>Compact Server</codeName>
      </serverInstanceType>
      <userData></userData>
      <accessControlGroupList>
        <accessControlGroup>
          <accessControlGroupConfigurationNo>4371</accessControlGroupConfigurationNo>
          <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
          <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
          <isDefault>true</isDefault>
          <createDate>2017-02-16T14:25:15+0900</createDate>
        </accessControlGroup>
      </accessControlGroupList>
      <instanceTagList/>
    </serverInstance>
  </serverInstanceList>
</getLoadBalancerTargetServerInstanceListResponse>

Was this article helpful?

Table of contents

Overview
Description
Request Parameters
Response Data Type
Examples
- Request
- Response