getServerProductList

Prev Next

VPC環境で利用できます。

NAVERクラウドプラットフォームが提供するサーバスペック商品リストを照会します。

リクエスト

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

メソッド URI
GET | POST /vserver/v2/getServerProductList
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

Server APIで共通して使用されるヘッダの詳細は、Serverのリクエストヘッダをご参照ください。

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

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
zoneCode String Optional ゾーンコード
serverImageProductCode String Conditional サーバイメージ商品コード
  • サーバイメージ商品で作成可能なサーバスペック商品リストを照会
  • serverImageProductCode、memberServerImageInstanceNoのうち、いずれか1つは必ず入力
    • 両方入力するとmemberServerImageInstanceNoが優先
  • getServerImageProductListを参照
exclusionProductCode String Optional 除外する商品コード
productCode String Optional 照会対象の商品コード
generationCode String Optional 世代コード
  • 世代コードで絞り込み
  • G1 | G2
memberServerImageInstanceNo String Conditional マイサーバイメージインスタンス番号
  • EOL OSに対する作成スペックを照会可能
  • serverImageProductCode、memberServerImageInstanceNoのうち、いずれか1つは必ず入力
    • 両方入力するとmemberServerImageInstanceNoが優先
  • getMemberServerImageInstanceListを参照
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getServerProductList
?regionCode=KR
&zoneCode=KR-1
&serverImageProductCode=SW.VSVR.OS.LNX64.UBNTU.SVR2004.B050
&exclusionProductCode=SVR.VSVR.STAND.C002.M008.NET.HDD.B050.G002
&productCode=SVR.VSVR.STAND.C002.M008.NET.SSD.B050.G002
&generationCode=G2
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
getServerProductListResponse Object - レスポンスの結果
getServerProductListResponse.requestId String - リクエスト ID
  • UUID形式
getServerProductListResponse.returnCode String - レスポンスコード
getServerProductListResponse.returnMessage String - レスポンスメッセージ

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

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

レスポンス例

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

{
  "getServerProductListResponse": {
    "totalRows": 1,
    "productList": [
      {
        "productCode": "SVR.VSVR.STAND.C002.M008.NET.SSD.B050.G002",
        "productName": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
        "productType": {
          "code": "STAND",
          "codeName": "Standard"
        },
        "productDescription": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
        "infraResourceType": {
          "code": "VSVR",
          "codeName": "Server (VPC)"
        },
        "cpuCount": 2,
        "memorySize": 8589934592,
        "baseBlockStorageSize": 53687091200,
        "osInformation": "",
        "diskType": {
          "code": "NET",
          "codeName": "ネットワークストレージ"
        },
        "dbKindCode": "",
        "addBlockStorageSize": 0,
        "generationCode": "G2"
      }
    ],
    "requestId": "dc99df0b-****-****-****-4491d7d03fb8",
    "returnCode": "0",
    "returnMessage": "success"
  }
}