MENU
      getServerInstanceList

        getServerInstanceList


        Article summary

        Overview

        Gets a list of server instances (VMs). The results can be paginated. userData is returned only when you get detailed information.

        Request

        Request parameters

        ParameterRequiredTypeLimitationDescription
        serverInstanceNoList.NNList<String>List of server instance numbers to get
        Get available values by using the getServerInstanceList action.
        Example) serverInstanceNoList.1=937507&serverInstanceNoList.2=1021003
        searchFilterNameNStringFilter name
        You can search server instances by server name and IP.
        Both private and public IP addresses are available.
        Options: serverName (Server name) | ip (IP address) [case insensitive]
        Map searchFilterName and searchFilterValue as follows.
        Example) searchFilterName=ip&searchFilterValue=10.41.3.81
        Example) searchFilterName=serverName&searchFilterValue=monkeys
        searchFilterValueNStringFileter value
        This value is mapped with searchFilterName.
        pageNoNIntegerMin: 0, Max: 2147483647Page number
        You can paginate results with pageNo.
        pageSizeNIntegerMin: 0, Max: 2147483647Page size to show when paginating results.
        You can paginate results with pageSize.
        serverInstanceStatusCodeNStringMin: 0, Max: 5Server instance status code
        List of servers by server instance status code you want to get
        Get available values by using the getServerInstanceList action.
        Please refer to the server instance status (serverInstanceStatus) of a server instance data type(ServerInstance) for available status.
        Example) serverInstanceStatusCode=NSTOP
        regionNoNStringRegion number
        Region from which you want to get a list of servers.
        Get available values by using the getRegionList action.
        zoneNoNStringZone number
        Zone from which you want to get a list of servers.
        Get available values by using the getZoneList action.
        Default: The first zone of the region.
        baseBlockStorageDiskTypeCodeNStringMin: 1, Max: 5Server disk type code
        Options: NET (NETWORK DISK) | LOCAL (LOCAL DISK)
        baseBlockStorageDiskDetailTypeCodeNStringMin: 1, Max: 5Detailed server disk type code
        Options: HDD | SSD
        sortedByNStringSort by
        You can sort servers by server name or server instance number.
        Options: serverName (Server name) | serverInstanceNo (Server instance number) [case insensitive]
        Default: serverInstanceNo
        Map sortedBy and sortingOrder as follows.
        Example) sortedBy=serverName&sortingOrder=ascending
        Example) sortedBy=serverInstanceNo&sortingOrder=descending
        sortingOrderNStringSorting order
        It shows results sorted by the specified sortedBy value in ascending or descending order.
        ascending | descending [case insensitive]
        Default: ascending
        serverInstanceTypeCodeList.NNList<String>List of server instance type codes you want to get
        Please refer to the server instance status (serverInstanceStatus) of a server instance data type(ServerInstance) for available status.
        Options: MICRO (Micro) | COMPT (Compact) | STAND (Standard) | HIMEM (High Memory) | GPU (GPU) | VDS (Virtual Dedicated Server)
        tagKeyList.NNList<String>Tag key of an instance to get
        You can use a tag key to get an instance.
        Get available values by using the getInstanceTagList action.
        Example) instanceTagList.1.tagKey=tag1
        tagKeyValue.NNList<String>Tag value of an instance to get
        You can use a tag value to get an instance.
        Get available values by using the getInstanceTagList action.
        Example) instanceTagList.1.tagValue=dolphins

        Response

        Response body

        Examples

        Request example

        GET {SERVER_API_URL}/getServerInstanceList
        ?serverInstanceStatusCode=RUN
        &searchFilterName=ip
        &searchFilterValue=106.10.46.237
        HTTP

        Response example

        <getServerInstanceListResponse>
          <requestId>0cf1cb98-6fdb-4064-804d-c1a14f903d9b</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <serverInstanceList>
            <serverInstance>
              <serverInstanceNo>1081368</serverInstanceNo>
              <serverName>s1673fa87a9b</serverName>
              <serverDescription></serverDescription>
              <cpuCount>1</cpuCount>
              <memorySize>1073741824</memorySize>
              <baseBlockStorageSize>53687091200</baseBlockStorageSize>
              <platformType>
                <code>LNX32</code>
                <codeName>Linux 32 Bit</codeName>
              </platformType>
              <loginKeyName>juhoon-kim</loginKeyName>
              <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
              <publicIp></publicIp>
              <privateIp>10.41.19.248</privateIp>
              <serverImageName>centos-6.3-32</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>2018-11-23T17:21:05+0900</createDate>
              <uptime>2018-11-23T17:36:40+0900</uptime>
              <serverImageProductCode>SPSW0LINUX000032</serverImageProductCode>
              <serverProductCode>SPSVRSTAND000056</serverProductCode>
              <isProtectServerTermination>false</isProtectServerTermination>
              <portForwardingPublicIp>106.10.51.90</portForwardingPublicIp>
              <zone>
                <zoneNo>3</zoneNo>
                <zoneName>KR-2</zoneName>
                <zoneCode>KR-2</zoneCode>
                <zoneDescription>Pyeongchon 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>MICRO</code>
                <codeName>Micro Server</codeName>
              </serverInstanceType>
              <userData></userData>
              <initScriptNo></initScriptNo>
              <accessControlGroupList>
                <accessControlGroup>
                  <accessControlGroupConfigurationNo>39995</accessControlGroupConfigurationNo>
                  <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                  <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                  <isDefault>true</isDefault>
                  <createDate>2018-04-09T11:12:54+0900</createDate>
                </accessControlGroup>
              </accessControlGroupList>
              <instanceTagList/>
            </serverInstance>
          </serverInstanceList>
        </getServerInstanceListResponse>
        XML

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.