CreateSnapshot

CreateSnapshotを使用すると、ボリュームのポイントインタイムコピーを作成できます。任意のボリュームまたは既存のSnapshotからSnapshotを作成できます。

このAPIメソッドでSnapshot IDを指定しない場合、ボリュームのアクティブなブランチからSnapshotが作成されます。Snapshotの作成元のボリュームがリモートクラスタにレプリケートされている場合は、Snapshotも同じターゲットにレプリケートできます。enableRemoteReplicationパラメータを使用して、Snapshot機能を使用したレプリケーションを有効にします。

注:クラスタフルのステージが1、2、または3の間はSnapshotを作成できます。クラスタフルが「ステージ4」または「ステージ5」に達すると、Snapshotを作成できなくなります。

パラメータ

このメソッドの入力パラメータは次のとおりです。

名前	説明	タイプ	デフォルト値	必須
attributes	JSONオブジェクト形式の名前と値のペアのリスト。	JSONオブジェクト	なし	×
enableRemoteReplication	Snapshotをリモートストレージにレプリケートするかどうかを指定します。有効な値は次のとおりです。 true：Snapshotがリモートストレージにレプリケートされます。 false：Snapshotがリモートストレージにレプリケートされません。	ブーリアン	false	×
name	Snapshotの名前。名前を入力しない場合、Snapshotの作成日時が使用されます。最大文字数は255文字です。	文字列	なし	×
retention	Snapshotが保持される時間。値を指定しない場合、Snapshotは無期限に保持されます。HH:mm:ss形式で入力します。	文字列	なし	×
snapMirrorLabel	SnapMirrorエンドポイントでのSnapshot保持ポリシーを指定するためにSnapMirrorソフトウェアで使用されるラベル。	文字列	なし	×
snapshotID	新しいSnapshotの作成元Snapshotの一意のID。Snapshot IDは、指定したボリュームのSnapshotのIDである必要があります。	整数	なし	×
volumeID	コピー元のボリュームイメージの一意のID。	整数	なし	○

戻り値

このメソッドの戻り値は次のとおりです。

名前	説明	タイプ
checksum	保存されたSnapshot内のチェックサムを表す文字列。このチェックサムを使用して、あとで他のSnapshotと比較してデータ内のエラーを検出できます。	文字列
snapshotID	新しいSnapshotの一意のID。	Snapshot ID
snapshot	作成されたSnapshotの情報を含むオブジェクト。	snapshot

要求例

このメソッドの要求例を次に示します。

{
   "method": "CreateSnapshot",
   "params": {
      "volumeID": 1
   },
   "id": 1
}

応答例

このメソッドの応答例を次に示します。

{
  "id": 1,
  "result": {
    "checksum": "0x0",
      "snapshot": {
        "attributes": {},
        "checksum": "0x0",
        "createTime": "2016-04-04T17:14:03Z",
        "enableRemoteReplication": false,
        "expirationReason": "None",
        "expirationTime": null,
        "groupID": 0,
        "groupSnapshotUUID": "00000000-0000-0000-0000-000000000000",
        "name": "2016-04-04T17:14:03Z",
        "snapshotID": 3110,
        "snapshotUUID": "6f773939-c239-44ca-9415-1567eae79646",
        "status": "done",
        "totalSize": 5000658944,
        "virtualVolumeID": null,
        "volumeID": 1
      },
        "snapshotID": 3110
  }
}