Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

createBlockStorageSnapshotInstance

Prev Next

VPC環境で利用できます。

ブロックストレージのスナップショットインスタンスを作成します。

構文

createBlockStorageSnapshotInstance構文は次の通りです。

./ncloud vserver createBlockStorageSnapshotInstance \
    --originalBlockStorageInstanceNo <original-block-storage-instance-no> \
    [--blockStorageSnapshotName <block-storage-snapshot-name>] \
    [--blockStorageSnapshotDescription <block-storage-snapshot-description>] \
    [--snapshotTypeCode <FULL|INCREMENTAL>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

createBlockStorageSnapshotInstanceの実行時に指定できるオプションについて説明します。

必須オプション

createBlockStorageSnapshotInstanceの必須オプションです。

オプション タイプ 必須の有無 説明
--originalBlockStorageInstanceNo String Required ソースストレージインスタンス番号

任意オプション

createBlockStorageSnapshotInstanceの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション タイプ 必須の有無 説明
--blockStorageSnapshotName String Optional スナップショットの名前
  • 未入力時、自動作成
  • 英数字、記号の-_を組み合わせて3~30文字以内で入力
  • 文字列の先頭文字は英字、末尾文字は英字または数字のみ使用
--blockStorageSnapshotDescription String Optional スナップショットの説明(Byte)
  • 0~1,000
--snapshotTypeCode String Optional スナップショットタイプコード
  • FULL (デフォルト) | INCREMENTAL
    • FULL: 全体ストレージスナップショット
    • INCREMENTAL: 増分スナップショット
  • 全体スナップショットを作成した後に増分スナップショットを作成可能
  • 増分スナップショットは最大7個まで作成可能

共通オプション

vserverコマンドで共通して使用するオプションについては、Server (VPC)のオプションをご参照ください。

ブロックストレージのスナップショットインスタンスの作成リクエストが成功すると、作成されたスナップショットの識別情報および構成情報が返されます。

コマンド

コマンドの例は次の通りです。

./ncloud vserver createBlockStorageSnapshotInstance \
    --originalBlockStorageInstanceNo 89012345 \
    --blockStorageSnapshotName test-snapshot-01 \
    --blockStorageSnapshotDescription "Test snapshot" \
    --snapshotTypeCode FULL \
    --regionCode KR \
    --output json

出力

出力の例は次の通りです。

{
  "createBlockStorageSnapshotInstanceResponse": {
    "totalRows": 1,
    "blockStorageSnapshotInstanceList": [
      {
        "blockStorageSnapshotInstanceNo": "90123456",
        "blockStorageSnapshotName": "test-snapshot-01",
        "blockStorageSnapshotVolumeSize": 10737418240,
        "originalBlockStorageInstanceNo": "89012345",
        "blockStorageSnapshotInstanceStatus": {
          "code": "INIT",
          "codeName": "ブロックストレージ INIT状態"
        },
        "blockStorageSnapshotInstanceOperation": {
          "code": "CREAT",
          "codeName": "ブロックストレージ CREAT OP"
        },
        "blockStorageSnapshotInstanceStatusName": "creating",
        "createDate": "2026-05-14T20:40:11+0900",
        "isEncryptedOriginalBlockStorageVolume": false,
        "blockStorageSnapshotDescription": "Test snapshot",
        "snapshotType": {
          "code": "FULL",
          "codeName": "Full Storage Snapshot"
        },
        "snapshotChainDepth": 0,
        "isBootable": true,
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "blockStorageVolumeType": {
          "code": "CB1",
          "codeName": "Common BlockStorage 1"
        }
      }
    ],
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "returnCode": "0",
    "returnMessage": "success"
  }
}