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.

getServerImageDetail

Prev Next

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

개요

서버 이미지 번호를 이용하여 서버 이미지 상세 정보를 조회합니다.

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String - 리전 코드
서버 이미지가 조회될 리전(Region) 결정 가능
regionCode는 getRegionList 액션을 통해 획득 가능
Default : getRegionList 조회 결과의 첫 번째 리전을 선택
serverImageNo No String - 조회할 서버 이미지 번호
serverImageNo는 getServerImageList 액션을 통해 획득 가능
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 getServerImageDetail --regionCode KR --serverImageNo ***5847

응답 예시

<getServerImageDetailResponse>
  <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>
</getServerImageDetailResponse>