サーバスペックの照会

Prev Next

VPC環境で利用できます。

クラスタまたはノードプールを作成する際に利用できるサーバスペックを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /option/server-product-code

リクエストヘッダ

Ncloud Kubernetes Service APIで共通して使用されるヘッダの詳細は、Ncloud Kubernetes Serviceの共通ヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
softwareCode String Required サーバイメージコード
  • zoneCodeとzoneNoのうち1つの有効な値を入力
zoneCode String Conditional ゾーンコード
  • zoneNoを入力しなかった場合、必須
  • getZoneListアクションを通じて確認
zoneNo String Conditional ゾーン番号
  • zoneCodeを入力しなかった場合、必須
  • getZoneListアクションを通じて確認

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location 'https://nks.apigw.ntruss.com/vnks/v2/option/server-product-code' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {API gateway signature}' \

レスポンス

レスポンス形式を説明します。

レスポンス構文

レスポンス構文は次の通りです。

[
  {
    "label": "string",
    "value": "string",
    "detail": {
      "productCode": "string",
      "productEnglishName": "string",
      "productName": "string",
      "serverSpecCode": "string",
      "serverSpecTypeCode": "string",
      "hypervisorCode": "string",
      "generationCode": "string",
      "productKindCode": "string",
      "productType2Code": "string",
      "cpuCount": 0,
      "memorySize": 0,
      "memorySizeGb": 0,
      "isFabricClusterType": false,
      "fabricClusterPoolList": [
        {
          "poolNo": 0,
          "poolName": "string"
        }
      ]
    }
  }
]

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
label String - サーバイメージ名
value String - サーバ商品コード
detail Object - サーバスペックの詳細情報
detail.productName String - 商品名
detail.serverImageNo Integer - サーバイメージ番号
detail.productCode String - 商品コード
detail.productEnglishName String - 商品名の英語表記
detail.serverSpecCode String - サーバスペックコード
detail.serverSpecTypeCode String - サーバスペックタイプコード
detail.hypervisorCode String - ハイパーバイザコード
detail.generationCode String - 世代コード
detail.productKindCode String - 商品の種類コード
detail.productType2Code String - 商品タイプ2コード
detail.cpuCount Integer - CPU数
detail.memorySize Integer - メモリ容量(バイト)
detail.memorySizeGb Integer - メモリ容量(GB)
detail.isFabricClusterType Boolean - Fabric Clusterタイプかどうか
detail.fabricClusterPoolList[] Array - Fabric Cluster Poolリスト
  • Fabric Clusterタイプの場合にのみ含める
detail.fabricClusterPoolList[].poolNo Integer - Fabric Cluster Pool番号
detail.fabricClusterPoolList[].poolName String - Fabric Cluster Pool名

レスポンスステータスコード

Ncloud Kubernetes Service APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Kubernetes Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

XENの場合

[
  {
    "label": "vCPU 2EA, Memory 4GB, [SSD]Disk 50GB",
    "value": "SVR.VSVR.HICPU.C002.M004.NET.SSD.B050.G002",
    "detail": {
      "cpuCount": 2,
      "productKoreanDesc": "vCPU 2個、メモリ 4GB、[SSD]ディスク 50GB",
      "softwareTypeCode": "",
      "packageProductYn": "N",
      "productKindCode": "INFRA",
      "productType2Code": "HICPU",
      "productCode": "SVR.VSVR.HICPU.C002.M004.NET.SSD.B050.G002",
      "productEnglishName": "vCPU 2EA, Memory 4GB, [SSD]Disk 50GB",
      "productDesc": "vCPU 2個、メモリ 4GB、[SSD]ディスク 50GB",
      "diskType2Code": "NET",
      "diskType2DetailCode": "SSD",
      "productName": "vCPU 2個、メモリ 4GB、[SSD]ディスク 50GB",
      "productEnglishDesc": "vCPU 2EA, Memory 4GB, [SSD]Disk 50GB",
      "memorySize": 4294967296,
      "memorySizeGb": 4
    }
  },
  {
    "label": "vCPU 2EA, Memory 4GB, [SSD]Disk 100GB",
    "value": "SVR.VSVR.HICPU.C002.M004.NET.SSD.B100.G002",
    "detail": {
      "cpuCount": 2,
      "productKoreanDesc": "vCPU 2個、メモリ 4GB、[SSD]ディスク 100GB",
      "softwareTypeCode": "",
      "packageProductYn": "N",
      "productKindCode": "INFRA",
      "productType2Code": "HICPU",
      "productCode": "SVR.VSVR.HICPU.C002.M004.NET.SSD.B100.G002",
      "productEnglishName": "vCPU 2EA, Memory 4GB, [SSD]Disk 100GB",
      "productDesc": "vCPU 2個、メモリ 4GB、[SSD]ディスク 100GB",
      "diskType2Code": "NET",
      "diskType2DetailCode": "SSD",
      "productName": "vCPU 2個、メモリ 4GB、[SSD]ディスク 100GB",
      "productEnglishDesc": "vCPU 2EA, Memory 4GB, [SSD]Disk 100GB",
      "memorySize": 4294967296,
      "memorySizeGb": 4
    }
  }
]

KVMの場合

[
  {
    "label": "c2-g3(vCPU 2EA, Memory 4GB)",
    "value": "c2-g3",
    "detail": {
      "productName": "c2-g3(vCPU 2EA, Memory 4GB)",
      "serverImageNo": 12345,
      "productCode": "SVR.VSVR.STAND.C002.M004.G003",
      "productEnglishName": "c2-g3(vCPU 2EA, Memory 4GB)",
      "serverSpecCode": "c2-g3",
      "serverSpecTypeCode": "STAND",
      "hypervisorCode": "KVM",
      "generationCode": "G003",
      "productKindCode": "INFRA",
      "productType2Code": "STAND",
      "cpuCount": 2,
      "memorySize": 4294967296,
      "memorySizeGb": 4,
      "isFabricClusterType": false,
      "fabricClusterPoolList": []
    }
  },
  {
    "label": "c4-g3(vCPU 4EA, Memory 8GB)",
    "value": "c4-g3",
    "detail": {
      "productName": "c4-g3(vCPU 4EA, Memory 8GB)",
      "serverImageNo": 12345,
      "productCode": "SVR.VSVR.STAND.C004.M008.G003",
      "productEnglishName": "c4-g3(vCPU 4EA, Memory 8GB)",
      "serverSpecCode": "c4-g3",
      "serverSpecTypeCode": "STAND",
      "hypervisorCode": "KVM",
      "generationCode": "G003",
      "productKindCode": "INFRA",
      "productType2Code": "STAND",
      "cpuCount": 4,
      "memorySize": 8589934592,
      "memorySizeGb": 8,
      "isFabricClusterType": false,
      "fabricClusterPoolList": []
    }
  }
]