createBlockStorageInstance

Prev Next

VPC環境で利用できます。

ブロックストレージインスタンスを作成します。

リクエスト

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

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
zoneCode String Conditional ゾーンコード
  • getZoneListを参照
  • KVMブロックストレージの場合、必ず入力
blockStorageName String Optional ブロックストレージ名
  • 英字の小文字、数字、記号の「-」を組み合わせて3~30文字以内で入力
  • 文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用
  • 入力しないと自動作成 (デフォルト)
blockStorageDiskDetailTypeCode String Optional ブロックストレージディスクの詳細タイプコード
  • SSD (デフォルト) | HDD
  • XENブロックストレージの場合、使用可能
blockStorageVolumeTypeCode String Conditional ブロックストレージボリュームタイプコード
serverInstanceNo String Conditional サーバインスタンス番号
  • getServerInstanceListを参照
  • XENブロックストレージの場合、必ず入力
  • KVMブロックストレージは作成と同時にサーバに割り当て不可
blockStorageSnapshotInstanceNo String Optional ブロックストレージスナップショットインスタンス番号
blockStorageSize Integer Conditional ブロックストレージ容量(GB)
  • XEN: 10~2000
  • KVM: 10~16380
  • 10GB単位で入力
  • XENブロックストレージスナップショットで作成時、自動決定
  • KVMブロックストレージスナップショットで作成時、既存のスナップショットサイズ以上に設定
  • ストレージタイプごとの制限事項: ストレージスペックを参照
blockStorageDescription String Optional ブロックストレージの説明(Byte)
  • 0~1000
isReturnProtection Boolean Optional 返却保護にするかどうか
  • true | false
    • true: 保護
    • false: 保護しない
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/createBlockStorageInstance
?regionCode=KR
&zoneCode=KR-1
&blockStorageName=test
&blockStorageVolumeTypeCode=CB1
&blockStorageSize=50
&isReturnProtection=false
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "createBlockStorageInstanceResponse": {
    "totalRows": 1,
    "blockStorageInstanceList": [
      {
        "blockStorageInstanceNo": "*****4316",
        "blockStorageName": "test",
        "blockStorageType": {
          "code": "SVRBS",
          "codeName": "サーバ BS"
        },
        "blockStorageSize": 53687091200,
        "blockStorageProductCode": "BST.CB.CB1.V001",
        "blockStorageInstanceStatus": {
          "code": "INIT",
          "codeName": "ブロックストレージ INIT状態"
        },
        "blockStorageInstanceOperation": {
          "code": "NULL",
          "codeName": "ブロックストレージ NULL OP"
        },
        "blockStorageInstanceStatusName": "initialized",
        "createDate": "2025-06-25T16:47:03+0900",
        "blockStorageDiskType": {
          "code": "NET",
          "codeName": "ネットワークストレージ"
        },
        "blockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "maxIopsThroughput": 150,
        "isEncryptedVolume": false,
        "zoneCode": "KR-1",
        "regionCode": "KR",
        "isReturnProtection": false,
        "blockStorageVolumeType": {
          "code": "CB1",
          "codeName": "Common BlockStorage 1"
        },
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "throughput": 104857600,
        "iops": 150
      }
    ],
    "requestId": "9a3574bb-****-****-****-ca3488c6e3dd",
    "returnCode": "0",
    "returnMessage": "success"
  }
}