getServerImageList
- Print
- PDF
getServerImageList
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Summary
Get a server image list.
Request
Request parameters
| Parameter name | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | - Region code Region in which the server image list will be viewed regionCode can be obtained through the getRegionList action Default: Select the first Region of the getRegionList query result | |
| serverImageNoList.N | No | List<String> | - Server image number list You can filter and search by server image number serverImageNo can be obtained through the getServerImageList action E.g., serverImageNoList.1=1234&serverImageNoList.2=2345 | |
| serverImageName | No | String | - Server image name You can filter and search by server image name | |
| serverImageStatusCode | No | String | - Server image status code You can filter and search by server image status code Options: INIT | CREAT | |
| serverImageTypeCodeList.N | No | List<String> | - Server image type code list You can filter and search by server image type code Options: SELF | NCP E.g., serverImageTypeCodeList.1=NCP | |
| hypervisorTypeCodeList.N | No | List<String> | - Hypervisor type code list You can filter and search by hypervisor type code Options: XEN | KVM E.g., hypervisorTypeCodeList.1=XEN&hypervisorTypeCodeList.2=KVM | |
| osTypeCodeList.N | No | List<String> | - OS type code list You can filter and search by OS type code Options: CENTOS | UBUNTU | WINDOWS E.g., osTypeCodeList.1=CENTOS&osTypeCodeList.2=UBUNTU | |
| platformCategoryCodeList.N | No | List<String> | - Platform category code list ou can filter and search by platform category code Options: OS | APP | DBMS | GPU E.g., platformCategoryCodeList.1=OS&platformCategoryCodeList.2=GPU | |
| pageNo | No | Integer | - Page numbers in paged results The results can be paged using pageNo and pageSize | |
| pageSize | Conditional | Integer | - Size of each page to display when paging Page the result values using pageNo and pageSize Required when entering pageNo | |
| sortedBy | No | String | - Sorting target The results can be sorted by server image name Options: serverImageName | |
| sortingOrder | No | String | - Sort order Set ascending or descending sorting when using sortedBy Options: ASC (ascending) | DESC (descending) Default: ASC | |
| responseFormatType | No | String | - Response result format type Options: xml | json Default : xml |
Response
Response body
Examples
Request example
GET {API_URL}/getServerImageList
?regionCode=KR
&serverImageNoList.1=***5847
&serverImageName=test-***
&serverImageStatusCode=CREAT
&osTypeCodeList.1=CENTOS
Response example
<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>
<productCode>SW.VSVR.OS.LNX64.CNTOS.0703.B050</productCode>
<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/>
</serverImage>
</serverImageList>
</getServerImageListResponse>
Was this article helpful?