15.5 スナップショットを作成する
データをバックアップ、またはバックアップしたデータを二次的に利用するためのスナップショットを作成します。また、スナップショットに対してクローンを実行することもできます。
実行権限
ストレージ管理者(ローカルバックアップ管理)
リクエストライン
POST <ベースURL>/simple/v1/objects/snapshots
リクエストメッセージ
- オブジェクトID
- なし。
- クエリパラメータ
- なし。
- ボディ
-
プールIDが13のプールに、スナップショットの作成元ボリューム(ボリュームID:100)からクローンを実行する例を次に示します。同時にスナップショットグループ(スナップショット名:snapshotGroup)を新規に作成します。
{ "params": [ { "masterVolumeId": 100, "poolId": 13, "snapshotGroupName": "snapshotGroup", "type": "Snap Clone" } ] }
プールIDが13のプールに、スナップショットの作成元ボリューム(ボリュームID:100、スナップショットグループ名:snapshotGroup)からスナップショットを作成する例を次に示します。
{ "params": [ { "masterVolumeId": 100, "poolId": 13, "snapshotGroupName": "snapshotGroup", "type": "Snapshot" } ] }
プールIDが13のプールに、スナップショットの作成元ボリューム(ボリュームID:100、スナップショットグループ名:snapshotGroup)からスナップショットを作成し、スナップショットの作成先ボリュームにボリュームIDを定義する例を次に示します。
{ "params": [ { "masterVolumeId": 100, "poolId": 13, "snapshotGroupName": "snapshotGroup", "type": "Mapped Snapshot" } ] }
属性
型
説明
params
object[]
作成するスナップショットの情報
- masterVolumeId(int)
(必須)スナップショットの作成元ボリュームIDを0~65279の整数で指定します。
- poolId(int)
(必須)スナップショットの差分データを格納するプールのプールIDを0~127の整数で指定します。
プールの使用率が枯渇しきい値を超えると作成済みのものを含むスナップショットが使用できなくなるおそれがあります。指定するプールに十分な空き容量があることを確認してください。
階層構造を持つプールは指定できません。
プールの使用率および階層構造を持つプールかどうかを確認するには、プールIDを指定して特定のプールの情報を取得するAPIを実行してください。
- snapshotGroupName(string)
(必須)スナップショットグループ名を1~32文字で指定します。
使用できる文字は次のとおりです。
0~9 A~Z a~z , - . / : @ \ _ 半角スペース
英字は、大文字と小文字を区別します。
半角スペースは、使用できる文字と文字の間には使用できますが、先頭と末尾には使用できません。
名前の先頭にハイフン(-)は使用できません。
新規のスナップショットグループ名を指定すると、同時にスナップショットグループも作成します。
- type(string)
(必須)スナップショットのタイプ
- Snap Clone:クローンを実行する
- Snapshot:スナップショットを作成する
- Mapped Snapshot:スナップショットを作成してスナップショットにボリュームIDを定義する
属性値にSnap CloneまたはMapped Snapshotを指定した場合、次の形式でスナップショットの作成先ボリュームにニックネームが自動で付与されます。
- Snap Cloneを指定した場合:
- 「Clone of ID:作成元ボリュームID」
- Mapped Snapshotを指定した場合:
- 「Snapshot of ID:作成元ボリュームID」
- destinationSize(int)
(任意)スナップショットの作成先ボリュームの容量を47~268435456の整数で指定します。
スナップショットの作成元ボリュームの容量より大きい値を指定してください。属性typeにSnap Cloneを指定した場合にだけ指定できます。
属性typeにSnap Cloneを指定して、この属性を省略した場合、スナップショットの作成元ボリュームと同じ値が指定されたと見なされます。
- masterVolumeId(int)
レスポンスメッセージ
- ボディ
-
属性
型
説明
statusResource
string
作成したスナップショットの実行結果の問い合わせに使用するURL
- メモ
-
非同期処理のAPIのステータス情報を取得するAPIを実行して、実行結果のステータス情報を参照することもできます。詳細は非同期処理のAPIのステータス情報を取得するAPIの説明を参照してください。
ステータスコード
この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。
コード例
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/simple/v1/objects/snapshots