getServerInstanceList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Overview

Searching a server instance list

Description

Search a server instance (VM) list
Paging can be processed and 'userData' will be provided only when you choose the detailed search on server instance

Request Parameters

Parameter Name	Requiredness	Type	Limitation	Description
serverInstanceNoList	No	String		Server instance No. list to search
searchFilterName	No	String		Server name (serverName) \| IP (ip) [Do not distinguish between uppercase and lowercase.] You can search either private or public IP.
searchFilterValue	No	String		Value to search
pageNo	No	Integer	Min:0, Max:2147483647	Page No. for each page size when there are multiple cases
pageSize	No	Integer	Min:0, Max:2147483647	Page size for one search page
serverInstanceStatusCode	No	String	Min:0, Max:5	Server list for each server instance status code to search To find a state in which input is possible, refer to server instance status (serverInstanceStatus) values of the server instance data type.
regionNo	No	String		You can reach a state in which input is possible by calling getRegionList.
zoneNo	No	String		You can decide which zone the server list will be requested at. You can get one by calling getZoneList. Default : Select the first Zone in the specific region
baseBlockStorageDiskTypeCode	No	String	Min : 1, Max : 5	Server disk type code NETWORK DISK(NET) \| LOCAL DISK(LOCAL)
baseBlockStorageDiskDetailTypeCode	No	String	Min : 1, Max : 5	Detailed server disk type code Hard disk (HDD) \| SSD (SSD)
sortedBy	No	String		Server name (serverName) \| Server instance No.(serverInstanceNo) [Do not distinguish between uppercase and lowercase.] Default : serverInstanceNo
sortingOrder	No	String		ascending \| descending [Do not distinguish between uppercase and lowercase.] Default : ascending
serverInstanceTypeCodeList	No	List		Server instance Type Code. list to search Micro(MICRO) \| Compact(COMPT) \| Standard(STAND) \| High Memory(HIMEM) \| GPU(GPU) \| Virtual Dedicated Server(VDS)
tagKeyList	No	List		tag key list to search
tagValueList	No	List		tag value list to search

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 String initScriptNo;
private List accessControlGroupList;
private List instanceTagList;
private List blockDevicePartitionList;

Examples

Request

ncloud server getServerInstanceList --serverInstanceStatusCode NSTOP --regionNo 2

Response

{
  "getServerInstanceListResponse": {
    "requestId": "164236f2-effd-4103-96ef-5631de14f5fc",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 2,
    "serverInstanceList": [
      {
        "serverInstanceNo": "324429",
        "serverName": "test-muk",
        "serverDescription": "",
        "cpuCount": 1,
        "memorySize": 2147483648,
        "baseBlockStorageSize": 53687091200,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "yskey",
        "isFeeChargingMonitoring": false,
        "publicIp": "192.168.10.128",
        "privateIp": "10.113.201.174",
        "serverImageName": "centos-5.7-64",
        "serverInstanceStatus": {
          "code": "NSTOP",
          "codeName": "Server normal stopped state"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "Server NULL OP"
        },
        "serverInstanceStatusName": "stopped",
        "createDate": "2017-05-19T12:07:12+0900",
        "uptime": "2017-05-23T16:56:45+0900",
        "serverImageProductCode": "SPSW0LINUX000010",
        "serverProductCode": "SPSVRSTAND000003",
        "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"
        },
        "serverInstanceType": {
          "code": "STAND",
          "codeName": "Standard"
        },
        "userData": "",
        "initScriptNo": "",
        "accessControlGroupList": [
          {
            "accessControlGroupConfigurationNo": "1038",
            "accessControlGroupName": "ncloud-default-acg",
            "accessControlGroupDescription": "Default AccessControlGroup",
            "isDefault": true,
            "createDate": "2013-12-03T10:37:39+0900"
          }
        ]
      },
      {
        "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"
        },
        "serverInstanceType": {
          "code": "STAND"
          "codeName": "Standard"
        },
        "userData": "",
        "accessControlGroupList": [
          {
            "accessControlGroupConfigurationNo": "1038",
            "accessControlGroupName": "ncloud-default-acg",
            "accessControlGroupDescription": "Default AccessControlGroup",
            "isDefault": true,
            "createDate": "2013-12-03T10:37:39+0900"
          }
        ]
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<getServerInstanceListResponse>
  <requestId>581b7b0d-2046-4222-ae16-1ffcfc166e79</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>
      <initScriptNo></initScriptNo>
      <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>
</getServerInstanceListResponse>

Was this article helpful?

What's Next

createServerInstances

Table of contents

Overview
Description
Request Parameters
Response Data Type
Examples