getServerSpecList

Prev Next

VPC環境で利用できます。

サーバスペックリストを照会します。

リクエスト

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

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
zoneCode String Optional ゾーンコード
serverImageNo String Optional サーバイメージ番号で絞り込み
serverSpecCodeList.N Array Optional サーバスペックコードリスト
  • サーバスペックコードで絞り込み
  • getServerSpecListを参照
  • <例> serverSpecCodeList.1=m2-g2-h100
hypervisorTypeCodeList.N Array Optional ハイパーバイザタイプコードリスト
  • XEN | KVM
  • ハイパーバイザタイプコードで絞り込み
  • <例> hypervisorTypeCodeList.1=XEN&hypervisorTypeCodeList.2=KVM
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getServerSpecList
?regionCode=KR
&serverImageNo=***8473
&serverSpecCodeList.1=c2-g3
&hypervisorTypeCodeList.1=KVM
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "getServerSpecListResponse": {
    "totalRows": 1,
    "serverSpecList": [
      {
        "serverSpecNo": 821,
        "serverSpecCode": "c2-g3",
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "generationCode": "G3",
        "cpuArchitectureType": {
          "code": "X86_64",
          "codeName": "x86 64bit"
        },
        "cpuCount": 2,
        "memorySize": 4294967296,
        "blockStorageMaxCount": 20,
        "blockStorageMaxIops": 5250,
        "blockStorageMaxThroughput": 81,
        "networkPerformance": 1000000000,
        "networkInterfaceMaxCount": 3,
        "serverSpecDescription": "vCPU 2EA, Memory 4GB",
        "serverProductCode": "SVR.VSVR.HICPU.C002.M004.G003"
      }
    ],
    "requestId": "466216b1-****-****-****-d1001e54a12d",
    "returnCode": "0",
    "returnMessage": "success"
  }
}