Snapshotの作成

POST /volume/{volume_id}/snapshot

概要説明

指定されたVolumeのSnapshotを作成します。

コピー先のVolume(SnapshotとなるVolume)を自動作成し、指定Volumeをコピー元としたSnapOPCまたはSnapOPC+ Sessionを作成します。

注意
  • コピー元のVolume Typeは、Standard、TPV、FTV、およびWSVです(システムボリュームは除きます)。

  • コピー先のVolume Typeは、TPVのみです。

  • すでに作成済みのVolumeをSnapshotにする(コピー先にしたSnapOPCまたはSnapOPC+ Sessionを作成する)ことはできません。

  • 作成したSnapshotのHrefは、「GET /job/{job_id}」のresource_href_listで確認できます。

  • 作成したSnapshotの状態は、「GET /volume/{volume_id}/copysession」で確認できます。

  • 1つのVolumeに対して作成できるSnapOPC+ Sessionの最大数は512です。

  • テナントユーザーの場合、自テナントに属するThin Provisioning Poolのみ指定できます。

  • 作成先のThin Provisioning Poolがテナントに属する場合、作成するSnapshotは作成先Thin Provisioning Poolのテナントと同一になります。

リクエスト例

  • Thin Provisioning Pool ID 0にVolume ID 100001のSnapshotを作成する場合の例です。

    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X POST "https://192.168.1.1:5665/api/v1/volume/100001/snapshot" -d
    '{
    "name": "snapshot#0",
    "tpp_id": 0
    }'

レスポンス例

{
  "job_id": 8192001,
  "job_href": "/api/v1/job/8192001"
}

Parameters

PATH PARAMETERS

volume_id

(required)

integer

Volume ID。

REQUEST BODY

name

(required)

string

作成するコピー先Volume名。

入力条件:

指定可能な文字数は1~32です。

  • 使用可能文字種は半角英数字記号です。ただし、","および"?"は除きます。

  • すでに存在するVolume名を付けることはできません。

  • 以下のVolume名を付けることはできません。
    • 「$VVOL_META」で始まるVolume名。

    • 「$DATA_CNTNR」で始まるVolume名。

    • 「$SYSVOL」で始まるVolume名。

tpp_id

(required)

指定可能な値は0~65535です。

作成先Thin Provisioning PoolのID。

入力条件:

  • 存在しないThin Provisioning Poolは指定できません。

  • テナントユーザーの場合、自テナントに属するThin Provisioningではないときは指定できません。

is_manual_snapshot

boolean

Default: false

作成するSnapshotを世代管理するかどうか。

trueを指定した場合、作成するSnapshotを世代管理しません(SnapOPC Sessionを作成します)。

falseを指定した場合、作成するSnapshotを世代管理します(SnapOPC+ Sessionを作成します)。

is_data_reduction_disabled

boolean

Data Reduction無効化設定。

trueを指定した場合、作成するVolumeへ書き込まれるデータへのDeduplication and/or Compressionを無効化します。

falseを指定した場合、作成するVolumeへ書き込まれるデータへのDeduplication and/or Compressionを有効化します。

入力条件:

  • 作成先Thin Provisioning PoolのData Reductionが有効の場合に限り指定可能です。

注意

SnapshotのData Reductionを有効にした場合、重複排除処理およびデータ圧縮処理はコピー処理と同期して行われるため、I/O性能やコピー性能が低下する可能性があります。Snapshot作成先のThin Provisioning PoolはData Reduction有効だが、コピー元Volumeへの性能劣化を抑止したい場合は、本ParameterによりSnapshotのData Reductionを無効化してください。

Responses

正常にジョブ登録できた場合、HTTPステータスコードが202 (Accepted)となりレスポンスボディを応答します。

RESPONSE BODY

job_id

integer

Job ID。

job_href

string

JobのResourceへのLink。