getServerProductList

Prev Next

Overview

Get the server product list.

Description

To create a server instance (VM), you must select and create a server product (server specifications).
Therefore, we provide an API that allows you to query server products.

Request parameters

Parameter name Required Type Restrictions Description
exclusionProductCode No String Min: 1, Max: 20 Enter the product code to exclude from the list
productCode No String Min: 1, Max: 20 Enter the product code to query from the list
Use when querying one item
generationCode No String Min: 1, Max: 20 Enter the product generation code to query from the list [either G1 or G2]
serverImageProductCode Conditional String Min: 1, Max: 20 Server image product code
The server specifications that can be created vary depending on the server image product
Either one of two parameters, serverImageProductCode or memberServerImageNo, is required.
It can be obtained through the getServerImageProdutList action
regionNo No String You can obtain the status where input is possible through the getRegionList action
zoneNo No String You can determine the zone in which the product list will be queried
You can obtain it through the getZoneList action
Default: Select the first zone of the Region
memberServerImageNo Conditional String Member server image number
Able to query the creation specifications for EOL OS
Either one of two parameters, serverImageProductCode or memberServerImageNo, is required.
When both serverImageProductCode and memberServerImageNo are entered, use memberServerImageNo to query
It can be obtained through the getMemberServerImageList action

Response data type

  • ProductList type
ProductList extends CommonResponse
private Integer totalRows;
private List<Product> productList = new ArrayList<Product>();
Product
private String productCode;
private String generationCode;
private String productName;
private CommonCode productType;
private String productDescription;
private CommonCode infraResourceType;
private CommonCode infraResourceDetailType;
private Integer cpuCount;
private Long memorySize;
private Long baseBlockStorageSize;
private CommonCode platformType;
private String osInformation;
private CommonCode diskType;
private String dbKindCode
private Long addBlockStorageSize;

Examples

Call 

ncloud server getServerProductList --serverImageProductCode SPSW0LINUX000043 --productCode SPSVRSSD00000009

Response 

{
  "getServerProductListResponse": {
    "requestId": "16996ca6-0f2d-46fa-aca4-4903a5aad3e2",
    "returnCode": "0",
    "returnMessage": "success",
    "productList": [
      {
        "productCode": "SPSVRSSD00000009",
        "generationCode": "G1",
        "productName": "vCPU 16EA, Memory 16GB, [SSD]Disk 50GB",
        "productType": {
          "code": "STAND",
          "codeName": "Standard"
        },
        "productDescription": "vCPU 16EA, Memory 16GB, [SSD]Disk 50GB",
        "infraResourceType": {
          "code": "SVR",
          "codeName": "Server"
        },
        "cpuCount": 16,
        "memorySize": 17179869184,
        "baseBlockStorageSize": 53687091200,
        "osInformation": "",
        "diskType": {
          "code": "NET",
          "codeName": "Network Storage"
        },
        "dbKindCode": "",
        "addBlockStorageSize": 0
      }
    ],
    "totalRows": 1
  }
}

<getServerProductListResponse>
  <requestId>6a17f564-8af2-44fe-b416-1c9ce7b2d200</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <productList>
    <product>
      <productCode>SPSVRSSD00000009</productCode>
      <generationCode>G1</generationCode>
      <productName>vCPU 16EA, Memory 16GB, [SSD]Disk 50GB</productName>
      <productType>
        <code>STAND</code>
        <codeName>Standard</codeName>
      </productType>
      <productDescription>vCPU 16EA, Memory 16GB, [SSD]Disk 50GB</productDescription>
      <infraResourceType>
        <code>SVR</code>
        <codeName>Server</codeName>
      </infraResourceType>
      <cpuCount>16</cpuCount>
      <memorySize>17179869184</memorySize>
      <baseBlockStorageSize>53687091200</baseBlockStorageSize>
      <osInformation></osInformation>
      <diskType>
        <code>NET</code>
        <codeName>Network Storage</codeName>
      </diskType>
      <dbKindCode></dbKindCode>
      <addBlockStorageSize>0</addBlockStorageSize>
    </product>
  </productList>
  <totalRows>1</totalRows>
</getServerProductListResponse>