getServerInstanceList

VPC 환경에서 이용 가능합니다.

개요

서버 인스턴스(VM) 리스트를 조회합니다.

요청

요청 파라미터

서버 인스턴스 리스트의 요청 파라미터는 다음과 같습니다.

파라미터명	필수 여부	타입	설명
regionCode	No	String	리전 코드 서버 인스턴스 리스트를 조회할 리전(Region)을 결정 가능 리전 코드는 getRegionList 액션을 통해 획득 가능 Default: getRegionList 조회 결과의 첫 번째 리전을 선택
vpcNo	No	String	VPC 번호 VPC 번호로 필터링하여 검색 가능 vpcNo는 getVpcList 액션을 통해 획득 가능
serverInstanceNoList	No	List<String>	서버 인스턴스 번호 서버 인스턴스 번호로 필터링하여 검색 가능 serverInstanceNo는 getServerInstanceList 액션을 통해 획득 가능 <예시> serverInstanceNoList 1234 2345
serverName	No	String	서버 이름 서버 이름으로 필터링하여 검색 가능
serverInstanceStatusCode	No	String	서버 인스턴스 상태 코드 서버 인스턴스 상태 코드로 필터링하여 검색 가능 Options INIT CREAT RUN NSTOP
baseBlockStorageDiskTypeCode	No	String	기본 블록 스토리지 디스크 유형 코드 서버 인스턴스의 기본 블록 스토리지 유형으로 필터링하여 검색 가능 Options: NET (NETWORK DISK)
baseBlockStorageDiskDetailTypeCode	No	String	기본 블록 스토리지 디스크 상세 유형 코드 서버 인스턴스의 기본 블록 스토리지 상세 유형으로 필터링하여 검색 가능 Options: HDD \| SSD
ip	No	String	IP 주소 서버 인스턴스의 IP 주소로 필터링하여 검색 가능 비공인 IP와 공인 IP 모두 필터링 대상이 됨
placementGroupNoList	No	List<String>	물리 배치 그룹 번호 리스트 서버 인스턴스가 소속되는 물리 배치 그룹 번호로 필터링하여 검색 가능 placementGroupNo는 getPlacementGroupList 액션을 통해 획득 가능 <예시> placementGroupNoList 1234 2345
hypervisorTypeCodeList	No	List<String>	하이퍼바이저 타입 코드 리스트 하이퍼바이저 타입으로 필터링하여 검색 가능 Options: XEN \| KVM <예시> hypervisorTypeCodeList KVM XEN
fabricClusterPoolNo	No	String	Fabric Cluster Pool 번호 Fabric Cluster Pool 번호로 필터링하여 검색 가능 fabricClusterPoolNo는 getFabricClusterPoolList 액션을 통해 획득 가능
fabricClusterNo	No	String	Fabric Cluster 번호 Fabric Cluster 번호로 필터링하여 검색 가능 fabricClusterNo는 getFabricClusterList 액션을 통해 획득 가능
fabricClusterMode	No	String	Fabric Cluster 모드 Fabric Cluster 모드로 필터링하여 검색 가능 Options: SINGLE \| CLUSTER
pageNo	No	Integer	페이징된 결과의 페이지 번호 결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageSize	Conditional	Integer	페이징 시 보여줄 각 페이지 사이즈 결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능 pageNo 입력 시 반드시 입력
sortedBy	No	String	정렬 대상 결과값을 서버 이름, 서버 인스턴스 번호로 정렬 가능 Options serverName serverInstanceNo
sortingOrder	No	String	정렬 순서 sortingOrder 사용 시 오름차순/내림차순 정렬을 설정함 Options: ASC(오름차순) \| DESC(내림차순) Default: ASC
output	No	String	응답 결과의 포맷 타입 Options: xml \| json Default: json

응답

응답 데이터 타입

서버 인스턴스 리스트의 응답 데이터 타입은 다음과 같습니다.

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

ServerInstance
private String serverInstanceNo;
private String serverName;
private String serverDescription;
private Integer cpuCount;
private Long memorySize;
private CommonCode platformType;
private String loginKeyName;
private String publicIpInstanceNo;
private String publicIp;
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 zoneCode;
private String regionCode;
private String vpcNo;
private String subnetNo;
private NetworkInterfaceNoList networkInterfaceNoList;
private String initScriptNo;
private CommonCode serverInstanceType;
private CommonCode baseBlockStorageDiskType;
private CommonCode baseBlockStorageDiskDetailType;
private String placementGroupNo;
private String placementGroupName;
private String memberServerImageInstanceNo;
private List<BlockDevicePartition> blockDevicePartitionList;
private CommonCode hypervisorType;
private String serverImageNo;
private String serverSpecCode;
private List<String> eventList;
private String fabricClusterPoolNo;
private String fabricClusterPoolName;
private String fabricClusterMode;
private String fabricClusterNo;
private String fabricClusterName;
private Boolean isPreInstallGpuDriver;

예시

요청 예시

ncloud vserver getServerInstanceList --regionCode KR --vpcNo ***04 --serverInstanceNoList ***4299 --serverName test-*** --serverInstanceStatusCode RUN --baseBlockStorageDiskTypeCode NET --baseBlockStorageDiskDetailTypeCode SSD --ip ***.***.111.215 --placementGroupNoList ***61

응답 예시

Server인 경우

{
  "getServerInstanceListResponse": {
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "serverInstanceList": [
      {
        "serverInstanceNo": "***4299",
        "serverName": "test-***",
        "serverDescription": "",
        "cpuCount": 2,
        "memorySize": 4294967296,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "test-***",
        "publicIpInstanceNo": "***7551",
        "publicIp": "***.***.111.215",
        "serverInstanceStatus": {
          "code": "RUN",
          "codeName": "Server run state"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "Server NULL OP"
        },
        "serverInstanceStatusName": "running",
        "createDate": "2020-08-19T15:05:07+0900",
        "uptime": "2020-08-19T15:08:09+0900",
        "serverImageProductCode": "SW.VSVR.OS.LNX64.CNTOS.0703.B050",
        "serverProductCode": "SVR.VSVR.STAND.C002.M004.NET.SSD.B050.G001",
        "isProtectServerTermination": false,
        "zoneCode": "KR-1",
        "regionCode": "KR",
        "vpcNo": "***04",
        "subnetNo": "***43",
        "networkInterfaceNoList": [
          "***87"
        ],
        "initScriptNo": "",
        "serverInstanceType": {
          "code": "STAND",
          "codeName": "Standard"
        },
        "baseBlockStorageDiskType": {
          "code": "NET",
          "codeName": "Network Storage"
        },
        "baseBlockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "placementGroupNo": "***61",
        "placementGroupName": "test-***",
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "serverImageNo": "61",
        "serverSpecCode": "mi2-g3i",
        "eventList": [
          "Scheduled Maintenance Event | 2025-03-19 PM 10:11 (UTC+09:00) migration"
        ]
      }
    ]
  }
}

<getServerInstanceListResponse>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <serverInstanceList>
    <serverInstance>
      <serverInstanceNo>***4299</serverInstanceNo>
      <serverName>test-***</serverName>
      <serverDescription></serverDescription>
      <cpuCount>2</cpuCount>
      <memorySize>4294967296</memorySize>
      <platformType>
        <code>LNX64</code>
        <codeName>Linux 64 Bit</codeName>
      </platformType>
      <loginKeyName>test-***</loginKeyName>
      <publicIpInstanceNo>***7551</publicIpInstanceNo>
      <publicIp>***.***.111.215</publicIp>
      <serverInstanceStatus>
        <code>RUN</code>
        <codeName>Server run state</codeName>
      </serverInstanceStatus>
      <serverInstanceOperation>
        <code>NULL</code>
        <codeName>Server NULL OP</codeName>
      </serverInstanceOperation>
      <serverInstanceStatusName>running</serverInstanceStatusName>
      <createDate>2020-08-19T15:05:07+0900</createDate>
      <uptime>2020-08-19T15:08:09+0900</uptime>
      <serverImageProductCode>SW.VSVR.OS.LNX64.CNTOS.0703.B050</serverImageProductCode>
      <serverProductCode>SVR.VSVR.STAND.C002.M004.NET.SSD.B050.G001</serverProductCode>
      <isProtectServerTermination>false</isProtectServerTermination>
      <zoneCode>KR-1</zoneCode>
      <regionCode>KR</regionCode>
      <vpcNo>***04</vpcNo>
      <subnetNo>***43</subnetNo>
      <networkInterfaceNoList>
        <networkInterfaceNo>***87</networkInterfaceNo>
      </networkInterfaceNoList>
      <initScriptNo></initScriptNo>
      <serverInstanceType>
        <code>STAND</code>
        <codeName>Standard</codeName>
      </serverInstanceType>
      <baseBlockStorageDiskType>
        <code>NET</code>
        <codeName>Network Storage</codeName>
      </baseBlockStorageDiskType>
      <baseBlockStorageDiskDetailType>
        <code>SSD</code>
        <codeName>SSD</codeName>
      </baseBlockStorageDiskDetailType>
      <placementGroupNo>***61</placementGroupNo>
      <placementGroupName>test-***</placementGroupName>
      <hypervisorType>
        <code>KVM</code>
        <codeName>KVM</codeName>
      </hypervisorType>
      <serverImageNo>61</serverImageNo>
      <serverSpecCode>mi2-g3i</serverSpecCode>
      <eventList>
        <event>Scheduled Maintenance Event | 2025-03-19 PM 10:11 (UTC+09:00) migration</event>
      </eventList>        
    </serverInstance>
  </serverInstanceList>
</getServerInstanceListResponse>

Bare Metal인 경우

{
  "getServerInstanceListResponse": {
    "totalRows": 1,
    "serverInstanceList": [
      {
        "serverInstanceNo": "****2594",
        "serverName": "test-***",
        "serverDescription": "test",
        "cpuCount": 64,
        "memorySize": 2199023255552,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "test-***",
        "serverInstanceStatus": {
          "code": "RUN",
          "codeName": "서버 RUN 상태"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "서버 NULL OP"
        },
        "serverInstanceStatusName": "running",
        "createDate": "2025-12-12T13:36:17+0900",
        "uptime": "2026-01-05T10:29:51+0900",
        "serverImageProductCode": "SW.VSVR.BM.OS.LNX64.UBNTU.SVR24.WRKND.G001",
        "serverProductCode": "SVR.VSVR.BM.GPU.H200N10.G008.C064.M2048.LOCAL.SSD.B48145.G001",
        "isProtectServerTermination": false,
        "zoneCode": "KR-1",
        "regionCode": "KR",
        "vpcNo": "***84",
        "subnetNo": "***54",
        "networkInterfaceNoList": [
          "***143"
        ],
        "serverInstanceType": {
          "code": "BM",
          "codeName": "BareMetal"
        },
        "baseBlockStorageDiskType": {
          "code": "LOCAL",
          "codeName": "Local 스토리지"
        },
        "baseBlockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "hypervisorType": {
          "code": "BM",
          "codeName": "BM"
        },
        "fabricClusterPoolNo": "***01",
        "fabricClusterPoolName": "test-***",
        "fabricClusterMode": "SINGLE",
        "isPreInstallGpuDriver": false
      }
    ],
    "requestId": "b340fcb4-74b1-4223-ab36-b8c1b67c56f1",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

<getServerInstanceListResponse>
    <totalRows>1</totalRows>
    <serverInstanceList>
        <serverInstance>
            <serverInstanceNo>****2594</serverInstanceNo>
            <serverName>test-***</serverName>
            <serverDescription>test</serverDescription>
            <cpuCount>64</cpuCount>
            <memorySize>2199023255552</memorySize>
            <platformType>
                <code>LNX64</code>
                <codeName>Linux 64 Bit</codeName>
            </platformType>
            <loginKeyName>test-***</loginKeyName>
            <serverInstanceStatus>
                <code>RUN</code>
                <codeName>서버 RUN 상태</codeName>
            </serverInstanceStatus>
            <serverInstanceOperation>
                <code>NULL</code>
                <codeName>서버 NULL OP</codeName>
            </serverInstanceOperation>
            <serverInstanceStatusName>running</serverInstanceStatusName>
            <createDate>2025-12-12T13:36:17+0900</createDate>
            <uptime>2026-01-05T10:29:51+0900</uptime>
            <serverImageProductCode>SW.VSVR.BM.OS.LNX64.UBNTU.SVR24.WRKND.G001</serverImageProductCode>
            <serverProductCode>SVR.VSVR.BM.GPU.H200N10.G008.C064.M2048.LOCAL.SSD.B48145.G001</serverProductCode>
            <isProtectServerTermination>false</isProtectServerTermination>
            <zoneCode>KR-1</zoneCode>
            <regionCode>KR</regionCode>
            <vpcNo>***84</vpcNo>
            <subnetNo>***54</subnetNo>
            <networkInterfaceNoList>
                <networkInterfaceNo>***143</networkInterfaceNo>
            </networkInterfaceNoList>
            <serverInstanceType>
                <code>BM</code>
                <codeName>BareMetal</codeName>
            </serverInstanceType>
            <baseBlockStorageDiskType>
                <code>LOCAL</code>
                <codeName>Local 스토리지</codeName>
            </baseBlockStorageDiskType>
            <baseBlockStorageDiskDetailType>
                <code>SSD</code>
                <codeName>SSD</codeName>
            </baseBlockStorageDiskDetailType>
            <hypervisorType>
                <code>BM</code>
                <codeName>BM</codeName>
            </hypervisorType>
            <fabricClusterPoolNo>***01</fabricClusterPoolNo>
            <fabricClusterPoolName>test-***</fabricClusterPoolName>
            <fabricClusterMode>SINGLE</fabricClusterMode>
            <isPreInstallGpuDriver>false</isPreInstallGpuDriver>
        </serverInstance>
    </serverInstanceList>
    <requestId>b340fcb4-74b1-4223-ab36-b8c1b67c56f1</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</getServerInstanceListResponse>

Documentation Index

getServerInstanceList

개요

요청

요청 파라미터

응답

응답 데이터 타입

예시

요청 예시

응답 예시

Server인 경우

Bare Metal인 경우