Documentation Index

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

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

getServerProductList

Prev Next

概要

サーバ賞品リストを照会

説明

サーバインスタンスを作成するには、サーバ商品(サーバスペック)を選択して作成する必要があります。
そのため、サーバ商品を照会できる APIを提供します。

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制限事項 説明
exclusionProductCode No String 最小: 1, 最大: 20 リストから外す商品コードを入力
productCode No String 最小: 1, 最大: 20 リストで照会する商品コードを入力
個別照会時に使用
generationCode No String 最小: 1, 最大: 20 リストで照会する商品世代コードを入力[G1、G2のうち1つ]
serverImageProductCode Conditional String 最小: 1, 最大: 20 サーバイメージ商品コード
サーバイメージ商品によって作成可能なサーバスペックが決まる
serverImageProductCodeと memberServerImageNoの2つのパラメータのうち、1つは必ず入力
getServerImageProdutListアクションを通じて取得可能
regionNo No String 入力可能な状態は、getRegionListアクションを通じて取得可能
zoneNo No String 商品リストが照会される ZONEを決定可能
getZoneListアクションを通じて取得可能
デフォルト: そのリージョンの最初の ZONEを選択
memberServerImageNo Conditional String 会員サーバイメージ番号
EOL OSに対する作成スペックを照会可能
serverImageProductCodeと memberServerImageNoの2つのパラメータのうち、1つは必ず入力
serverImageProductCodeと memberServerImageNoを両方入力すると memberServerImageNoを利用して照会
getMemberServerImageListアクションを通じて取得可能

レスポンスデータタイプ

  • ProductListタイプ
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;

呼び出し

ncloud server getServerProductList --serverImageProductCode SPSW0LINUX000043 --productCode SPSVRSSD00000009

レスポンス

{
  "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>