Documentation Index

Fetch the complete documentation index at: https://cli-fin.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getServerImageList

Prev Next

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

개요

서버 이미지 리스트를 조회합니다.

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String - 리전 코드
서버 이미지 리스트가 조회될 리전(Region) 결정 가능
regionCode는 getRegionList 액션을 통해 획득 가능
Default : getRegionList 조회 결과의 첫 번째 리전을 선택
serverImageNoList.N No List<String> - 서버 이미지 번호 리스트
서버 이미지 번호로 필터링하여 검색 가능
serverImageNo는 getServerImageList 액션을 통해 획득 가능
ex) serverImageNoList.1=1234&serverImageNoList.2=2345
serverImageName No String - 서버 이미지 이름
서버 이미지 이름으로 필터링하여 검색 가능
serverImageStatusCode No String - 서버 이미지 상태 코드
서버 이미지 상태 코드로 필터링하여 검색 가능
Options : INIT | CREAT | CREFL
serverImageTypeCodeList.N No List<String> - 서버 이미지 타입 코드 리스트
서버 이미지 타입 코드로 필터링하여 검색 가능
Options : SELF | NCP
ex) serverImageTypeCodeList.1=NCP
hypervisorTypeCodeList.N No List<String> - 하이퍼바이저 타입 코드 리스트
하이퍼바이저 타입 코드로 필터링하여 검색 가능
Options : XEN | RHV | KVM
ex) hypervisorTypeCodeList.1=XEN&hypervisorTypeCodeList.2=KVM
osTypeCodeList.N No List<String> - OS 타입 코드 리스트
OS 타입 코드로 필터링하여 검색 가능
Options : CENTOS | UBUNTU | WINDOWS | ROCKY | NAVIX
ex) osTypeCodeList.1=CENTOS&osTypeCodeList.2=UBUNTU
platformCategoryCodeList.N No List<String> - 플랫폼 카테고리 코드 리스트
플랫폼 카테고리 코드로 필터링하여 검색 가능
Options : OS | APP | DBMS | GPU
ex) platformCategoryCodeList.1=OS&platformCategoryCodeList.2=GPU
pageNo No Integer - 페이징된 결과의 페이지 번호
결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageSize Conditional Integer - 페이징 시 보여줄 각 페이지 사이즈
결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageNo 입력시 반드시 입력 필요
sortedBy No String - 정렬 대상
결과값을 서버 이미지 이름으로 정렬 가능
Options : serverImageName
sortingOrder No String - 정렬 순서
sortedBy 이용시 오름차순/내림차순 정렬을 설정
Options : ASC (오름차순) | DESC (내림차순)
Default : ASC
output No String - 응답 결과의 포맷 타입
Options : xml | json
Default : json

응답

응답 데이터 타입

  • ServerImageList 타입
ServerImageList extends CommonResponse
private Integer totalRows;
private List serverImageList = new ArrayList<>();
ServerImage
private String serverImageNo;
private String serverImageName;
private String serverImageDescription;
private CommonCode serverImageType;
private CommonCode serverImageLifeCyclePhase;
private CommonCode hypervisorType;
private CommonCode cpuArchitectureType;
private CommonCode osCategoryType;
private CommonCode osType;
private String serverImageStatusName;
private CommonCode serverImageStatus;
private CommonCode serverImageOperation;
private String serverImageProductCode;
private Date createDate;
private CommonCode shareStatus;
private SharedLoginIdList sharedLoginIdList;
private String platformCategoryCode;
private List blockStorageMappingList;
BlockStorageMapping
private Integer order;
private String blockStorageSnapshotInstanceNo;
private String blockStorageSnapshotName;
private Long blockStorageSize;
private String blockStorageName;
private CommonCode blockStorageVolumeType;
private Long iops;
private Long throughput;
private Boolean isEncryptedVolume;

예시

요청 예시

ncloud vserver getServerImageList --regionCode KR --serverImageNoList ***5847 --serverImageName test-*** --serverImageStatusCode CREAT --osTypeCodeList CENTOS

응답 예시

<getServerImageListResponse>
  <requestId></requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <serverImageList>
    <serverImage>
      <serverImageNo>***5847</serverImageNo>
      <serverImageName>test-***</serverImageName>
      <serverImageDescription></serverImageDescription>
      <serverImageType>
        <code>NCP</code>
        <codeName>NCP Server Image</codeName>
      </serverImageType>
      <serverImageLifeCyclePhase>
        <code>IN_SERVICE</code>
        <codeName>In Service</codeName>
      </serverImageLifeCyclePhase>
      <hypervisorType>
        <code>XEN</code>
        <codeName>XEN</codeName>
      </hypervisorType>
      <cpuArchitectureType>
        <code>X86_64</code>
        <codeName>x86 64bit</codeName>
      </cpuArchitectureType>
      <osCategoryType>
        <code>LINUX</code>
        <codeName>LINUX</codeName>
      </osCategoryType>
      <osType>
        <code>CENTOS</code>
        <codeName>CENTOS</codeName>
      </osType>
      <serverImageProductCode>SW.VSVR.OS.LNX64.CNTOS.0703.B050</serverImageProductCode>
      <serverImageStatus>
        <code>CREAT</code>
        <codeName>Server created state</codeName>
      </serverImageStatus>
      <serverImageOperation>
        <code>NULL</code>
        <codeName>NULL OP</codeName>
      </serverImageOperation>
      <serverImageStatusName>created</serverImageStatusName>
      <createDate>2020-08-24T10:34:27+0900</createDate>
      <blockStorageMappingList>
        <blockStorageMapping>
          <order>0</order>
          <blockStorageSize>53687091200</blockStorageSize>
          <blockStorageVolumeType>
            <code>HDD</code>
            <codeName>HDD</codeName>
          </blockStorageVolumeType>
          <isEncryptedVolume>false</isEncryptedVolume>
        </blockStorageMapping>
      </blockStorageMappingList>
      <shareStatus>
        <code>NULL</code>
        <codeName>NSI Share NULL State</codeName>
      </shareStatus>
      <sharedLoginIdList/>
      <platformCategoryCode>OS</platformCategoryCode>
    </serverImage>
  </serverImageList>
</getServerImageListResponse>