ModifySnapshot

ModifySnapshotを使用すると、Snapshotに現在割り当てられている属性を変更できます。また、このメソッドを使用すると、読み取り / 書き込み（ソース）ボリュームで作成されたSnapshotを、Elementソフトウェアを実行しているターゲットストレージクラスタにリモートでレプリケートできます。

パラメータ

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

名前	説明	タイプ	デフォルト値	必須
enableRemoteReplication	作成したSnapshotをリモートストレージクラスタにレプリケートできるようにします。有効な値は次のとおりです。 true：Snapshotがリモートストレージにレプリケートされます。 false：Snapshotがリモートストレージにレプリケートされません。	ブーリアン	false	×
expirationTime	Snapshotを削除する時刻を設定します。「null」に設定すると、Snapshotが無期限に保存されます。	ISO 8601形式の日付文字列	なし	×
name	Snapshotの名前。名前を入力しない場合、Snapshotの作成日時が使用されます。最大文字数は255文字です。	文字列	なし	×
snapMirrorLabel	SnapMirrorエンドポイントでのSnapshot保持ポリシーを指定するためにSnapMirrorソフトウェアで使用されるラベル。	文字列	なし	×
snapshotID	Snapshotの識別子。	文字列	なし	○

戻り値

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

名前	説明	タイプ
snapshot	変更されたSnapshotの情報を含むオブジェクト。	snapshot

要求例

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

{
  "method": "ModifySnapshot",
  "params": {
    "snapshotID": 3114,
    "enableRemoteReplication": "true",
    "name" : "Chicago"
  },
  "id": 1
}

応答例

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

{
  "id": 1,
  "result": {
    "snapshot": {
      "attributes": {},
      "checksum": "0x0",
      "createTime": "2016-04-04T17:26:20Z",
      "enableRemoteReplication": true,
      "expirationReason": "None",
      "expirationTime": null,
      "groupID": 0,
      "groupSnapshotUUID": "00000000-0000-0000-0000-000000000000",
      "name": "test1",
      "snapshotID": 3114,
      "snapshotUUID": "5809a671-4ad0-4a76-9bf6-01cccf1e65eb",
      "status": "done",
      "totalSize": 5000658944,
      "virtualVolumeID": null,
      "volumeID": 1
    }
  }
}