getBlockStorageVolumeTypeList

Prev Next

VPC環境で利用できます。

使用可能なブロックストレージボリュームタイプコードリストを照会します。

リクエスト

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

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
zoneCode String Optional ゾーンコード
blockStorageVolumeTypeCodeList.N Array Optional ブロックストレージボリュームタイプコードリスト
  • ブロックストレージボリュームタイプコードで絞り込み
  • getBlockStorageVolumeTypeListを参照
  • <例> blockStorageVolumeTypeCodeList.1=SSD&blockStorageVolumeTypeCodeList.2=CB1
hypervisorTypeCodeList.N Array Optional ハイパーバイザタイプコードリスト
  • XEN | KVM
  • getHypervisorTypeListを参照
  • ハイパーバイザタイプコードで絞り込み
  • <例> hypervisorTypeCodeList.1=XEN&hypervisorTypeCodeList.2=KVM
serverSpecCode String Optional サーバスペックコードで絞り込み
isBaseStorageAvailable Boolean Optional 基本ストレージとして使用可能かで絞り込み
  • true | false
    • true: 可能
    • false: 不可
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getBlockStorageVolumeTypeList
?regionCode=KR
&blockStorageVolumeTypeCodeList.1=CB1
&blockStorageVolumeTypeCodeList.2=SSD
&hypervisorTypeCodeList.1=XEN
&hypervisorTypeCodeList.2=KVM
&isBaseStorageAvailable=true
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "getBlockStorageVolumeTypeListResponse": {
    "totalRows": 2,
    "blockStorageVolumeTypeList": [
      {
        "blockStorageVolumeType": {
          "code": "CB1",
          "codeName": "Common BlockStorage 1"
        },
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "minBaseVolumeSize": 10,
        "maxBaseVolumeSize": 2000,
        "minVolumeSize": 10,
        "maxVolumeSize": 16380,
        "minIops": 100,
        "maxIops": 16000,
        "minThroughput": 100,
        "maxThroughput": 250,
        "zoneCodeList": [
          "KR-1",
          "KR-2"
        ],
        "isBaseStorageAvailable": true
      },
      {
        "blockStorageVolumeType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "hypervisorType": {
          "code": "XEN",
          "codeName": "XEN"
        },
        "minBaseVolumeSize": 50,
        "maxBaseVolumeSize": 100,
        "minVolumeSize": 10,
        "maxVolumeSize": 2000,
        "zoneCodeList": [
          "KR-2",
          "KR-1"
        ],
        "isBaseStorageAvailable": true
      }
    ],
    "requestId": "fc05c29d-****-****-****-149469afb646",
    "returnCode": "0",
    "returnMessage": "success"
  }
}