createBlockStorageSnapshotInstance

Prev Next

VPC環境で利用できます。

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

リクエスト

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

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getBlockStorageInstanceListを参照
    • 照会結果の最初のリージョン (デフォルト)
  • ブロックストレージが位置するリージョンにスナップショットを作成可能
blockStorageSnapshotName String Optional スナップショット名
  • 英数字、記号の「-」、「_」を組み合わせて3~30文字以内で入力
  • 文字列の先頭文字は英字、末尾文字は英字または数字のみ使用
  • 入力しないと自動作成 (デフォルト)
blockStorageSnapshotDescription String Optional スナップショットの説明(Byte)
  • 0~1000
originalBlockStorageInstanceNo String Required ソースストレージインスタンス番号
snapshotTypeCode String Optional スナップショットタイプコード
  • FULL (デフォルト) | INCREMENTAL
    • FULL: 全体ストレージスナップショット
    • INCREMENTAL: 増分スナップショット
  • 全体スナップショットを作成した後に増分スナップショットを作成可能
  • 増分スナップショットは最大7個まで作成可能
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/createBlockStorageSnapshotInstance
?regionCode=KR
&blockStorageSnapshotName=snapshot-test
&originalBlockStorageInstanceNo=*****3168
&snapshotTypeCode=FULL
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "createBlockStorageSnapshotInstanceResponse": {
    "totalRows": 1,
    "blockStorageSnapshotInstanceList": [
      {
        "blockStorageSnapshotInstanceNo": "*****4323",
        "blockStorageSnapshotName": "snapshot-test",
        "blockStorageSnapshotVolumeSize": 10737418240,
        "originalBlockStorageInstanceNo": "*****3168",
        "blockStorageSnapshotInstanceStatus": {
          "code": "INIT",
          "codeName": "ブロックストレージ INIT状態"
        },
        "blockStorageSnapshotInstanceOperation": {
          "code": "CREAT",
          "codeName": "ブロックストレージ CREAT OP"
        },
        "blockStorageSnapshotInstanceStatusName": "creating",
        "createDate": "2025-06-25T16:50:14+0900",
        "isEncryptedOriginalBlockStorageVolume": false,
        "snapshotType": {
          "code": "FULL",
          "codeName": "Full Storage Snapshot"
        },
        "snapshotChainDepth": 0,
        "isBootable": false,
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "blockStorageVolumeType": {
          "code": "CB1",
          "codeName": "Common BlockStorage 1"
        }
      }
    ],
    "requestId": "bd72f843-****-****-****-3a56b6bf2a69",
    "returnCode": "0",
    "returnMessage": "success"
  }
}