スナップショットを作成
使用できます `CreateSnapshot`ボリュームのポイントインタイムコピーを作成します。任意のボリュームまたは既存のスナップショットからスナップショットを作成できます。
この API メソッドで SnapshotID を指定しない場合は、ボリュームのアクティブ ブランチからスナップショットが作成されます。スナップショットの作成元のボリュームがリモート クラスターに複製されている場合は、スナップショットも同じターゲットに複製できます。スナップショット レプリケーションを有効にするには、enableRemoteReplication パラメータを使用します。
|
|
クラスターの満杯度がステージ 1、2、または 3 の場合、スナップショットを作成できます。クラスターの満杯状態がステージ 4 または 5 に達すると、スナップショットを作成できません。 |
パラメータ
このメソッドには次の入力パラメータがあります。
| Name | 説明 | タイプ | デフォルト値 | 必須 |
|---|---|---|---|---|
|
JSON オブジェクト形式の名前と値のペアのリスト。 |
JSONオブジェクト |
なし |
いいえ |
|
スナップショットをリモート ストレージに複製するかどうかを指定します。有効な値は次のとおりです。
|
ブーリアン |
false |
いいえ |
|
以前のスナップショットのレプリケーションが進行中の場合はスナップショットを作成しないことを指定します。有効な値は次のとおりです。
|
ブーリアン |
|
いいえ |
有効期限 |
スナップショットを削除できるまでの時間を指定します。使用できません |
string |
なし |
いいえ |
|
スナップショットの名前。名前を入力しない場合は、スナップショットが作成された日時が使用されます。許可される名前の最大長は 255 文字です。 |
string |
なし |
いいえ |
|
このパラメータは `expirationTime`パラメータと同じですが、時刻形式は HH:mm:ss です。どちらでもない `expirationTime`または `retention`が指定されている場合、スナップショットは期限切れになりません。 |
string |
なし |
いいえ |
|
SnapMirrorエンドポイントのスナップショット保持ポリシーを指定するためにSnapMirrorソフトウェアによって使用されるラベル。 |
string |
なし |
いいえ |
|
新しいスナップショットが作成されるスナップショットの一意の ID。渡されるスナップショットIDは、指定されたボリューム上のスナップショットである必要があります。 |
integer |
なし |
いいえ |
|
コピー元のボリューム イメージの一意の ID。 |
integer |
なし |
はい |
戻り値
このメソッドには次の戻り値があります。
Name |
説明 |
タイプ |
checksum |
保存されたスナップショット内の正しい数字を表す文字列。このチェックサムは、後で他のスナップショットと比較してデータ内のエラーを検出するために使用できます。 |
string |
スナップショットID |
新しいスナップショットの一意の ID。 |
Snapshot ID |
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
}
}
Exception
xNotPrimary例外は、 CreateSnapshot API が呼び出されましたが、スナップショットの作成に失敗しました。これは想定される動作です。再試行 `CreateSnapshot`API 呼び出し。
バージョン以降の新機能
9.6