getServerInstanceList

Prev Next

개요

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

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String - 리전 코드
서버 인스턴스 리스트가 조회될 리전(Region) 결정 가능
regionCode는 getRegionList 액션을 통해 획득 가능
Default : getRegionList 조회 결과의 첫 번째 리전을 선택
vpcNo No String - VPC 번호
VPC 번호로 필터링하여 검색 가능
vpcNo는 getVpcList 액션을 통해 획득 가능
serverInstanceNoList No List<String> - 서버 인스턴스 번호 리스트
서버 인스턴스 번호로 필터링하여 검색 가능
serverInstanceNo는 getServerInstanceList 액션을 통해 획득 가능
ex) --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 액션을 통해 획득 가능
ex) --placementGroupNoList 1234 2345
hypervisorTypeCodeList No List<String> - 하이퍼바이저 타입 코드 리스트
하이퍼바이저 타입으로 필터링하여 검색 가능
Options : XEN | RHV
ex) --hypervisorTypeCodeList RHV XEN
pageNo No Integer - 페이징된 결과의 페이지 번호
결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageSize Conditional Integer - 페이징 시 보여줄 각 페이지 사이즈
결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageNo 입력시 반드시 입력필요
sortedBy No String - 정렬 대상
결과값을 서버 이름, 서버 인스턴스 번호로 정렬 가능
Options : serverName | serverInstanceNo
sortingOrder No String - 정렬 순서
sortedBy 이용시 오름차순/내림차순 정렬을 설정함
Options : ASC (오름차순) | DESC (내림차순)
Default : ASC
responseFormatType No String - 응답 결과의 포맷 타입
Options : xml | json
Default : xml

응답

응답 데이터 타입

  • ServerInstanceList 타입
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 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 blockDevicePartitionList;
private CommonCode hypervisorType;
private String serverImageNo;
private String serverSpecCode;
private List<String> eventList;

예시

요청 예시

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

응답 예시

<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>FKR-1</zoneCode>
      <regionCode>FKR</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>XEN</code>
        <codeName>XEN</codeName>
      </hypervisorType>
      <serverImageNo>61</serverImageNo>
      <serverSpecCode>mi2-g3i</serverSpecCode>
      <eventList>
        <string>Scheduled Maintenance Event | 2025-03-19 PM 10:11 (UTC+09:00) migration</string>
      </eventList>        
    </serverInstance>
  </serverInstanceList>
</getServerInstanceListResponse>