Volumeの作成

POST /volume

概要説明

新規にVolumeを作成します。

注意
  • 以下のTypeのVolumeの作成はETERNUS RESTful APIではサポートしません。

    • WSV

    • SDPV

    • SDV

    • FTV

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

  • テナントユーザーの場合、TPV以外のVolumeを作成することはできません。

リクエスト例

  • Thin Provisioning Pool ID 0 に容量が40GBのVolume (name = sample_vol) を作成する場合の例です。

    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X POST "https://192.168.1.1:5665/api/v1/volume"
    -d
    '{"name":"sample_vol","capacity":40960,"tpp_id":0}'
  • RAID Group ID 10 に容量が5GBのコピー先保護が有効なVolume (name = test_vol) を3つ作成する場合の例です。

    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X POST "https://192.168.1.1:5665/api/v1/volume"
    -d
    '{"name":"test_vol","capacity":5120,"raidgroup_id":10,"count":3,"is_copy_protection_enabled":"true"}'

レスポンス例

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

Parameters

REQUEST BODY

name

(required)

string

Volume名。

"count"で2以上の数値を指定した場合、Volume名の末尾に十進数の通し番号が自動で付与されます。

付与される通し番号の開始番号を"start_numer"で指定できます。

付与される通し番号の桁数を"number_of_digits"で指定できます。

例えば、"name"を"Volume#"、"count"を2、"start_number"を10、"number_of_digits"を3と指定した場合、作成されるVolumeのVolume名は「Volume#010」「Volume#011」になります。

入力条件:

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

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

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

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

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

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

capacity

(required)

integer

Volumeの容量。

単位はMBです。

入力条件:

  • 指定可能な値は24~134217728です。

  • Volumeの作成先をThin Provisioning Poolにする場合は以下の条件があります。
    • 1回の操作で作成できるVolumeの総容量は2PBを超えることはできません。

    • 装置のTPV (Data Reductionが有効な場合は除く) およびFTVの総容量は装置のMaximum Pool Capacityを超えることはできません。

    • Data Reductionが有効Volumeの総容量は、作成先Thin Provisioning Poolに存在するData Container Volume容量の10倍を超えることはできません。

  • Volumeの作成先をRAID Groupにする場合、作成先RAID Groupの最大空き容量を超える容量を指定することはできません。

tpp_id

integer

作成先Thin Provisioning PoolのID。

Volumeの作成先をThin Provisioning Poolにする場合は、本項目の設定は必須です。

入力条件:

  • raidgroup_idを指定する場合は、本項目は指定できません。

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

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

  • テナントユーザーではない場合、テナントに属するThin Provisioning Poolを指定すると、作成したVolumeはThin Provisioning Poolのテナントと同じテナントに所属します。

raidgroup_id

integer

作成先RAID GroupのID。

Volumeの作成先をRAID Groupにする場合は指定が必須です。

入力条件:

  • tpp_idを設定した場合は、本項目は指定できません。

  • 存在しないRAID Groupは指定できません。

  • テナントユーザーは指定できません。

volume_number

integer

作成するVolumeのVolume Number。

省略した場合、自動で採番します。

入力条件:

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

  • 既存Volumeで使用中のVolume Numberは指定できません。

  • countで2以上を指定している場合は、本項目は指定できません。

count

integer

Default: 1

Volumeの作成数。

入力条件:

  • tpp_idまたはraidgroup_idを指定した場合、指定可能な値は1~512です。

start_number

integer

Default: 0

複数Volume作成時にVolume名の末尾に付加する通し番号の開始番号。

入力条件:

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

  • countが1または省略された場合、本項目は指定できません。

number_of_digits

integer

Default: 1

複数Volume作成時にVolume名の末尾に付加する通し番号の桁数。

入力条件:

  • 指定可能な値は1~5です。

  • countが1または省略された場合、本項目は指定できません。

is_data_reduction_disabled

boolean

Default: false

Data Reduction無効化設定。

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

入力条件:

  • Volumeの作成先がThin Provisioning Poolである場合に限り、本項目を指定できます。

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

is_copy_protection_enabled

boolean

Default: false

Copy先保護設定。

trueを指定した場合、VolumeがCopy先として使用できなくなります。

想定外のコピーによるデータ破壊を防ぎたい場合に指定します。

入力条件:

  • Advanced Copy Licenseが装置に登録されている必要があります。

is_exc_disabled

boolean

Default: false

Extreme Cache Pool設定。

trueを指定した場合、作成したVolumeに対してアクセスする際に、Extreme Cache Poolを使用しません。

入力条件:

  • 装置のExtreme Cache Poolが有効の場合に限り、本項目を指定できます。

  • 作成先Thin Provisioning PoolまたはRAID GroupがSAS SSDまたはNVMe SSDで構成されている場合、本項目は指定できません。

  • 作成先Thin Provisioning PoolのData Reductionが有効かつVolumeのData Reductionを無効にする設定をしていない場合、本項目は指定できません。

is_thick_provisioned

boolean

Default: false

Allocation方式。

trueを指定した場合、Volume作成時に容量分の物理領域が割り当てられています。

Thin Provisioning Poolの物理容量枯渇によるシステム停止を防止したい場合に指定します。

入力条件:

  • Volumeの作成先がThin Provisioning Poolである場合に限り、本項目を指定できます。

  • 本項目をtrueに指定した場合、作成先Thin Provisioning Poolの未使用容量がVolumeのSizeより小さいときはVolume作成が失敗します。

  • 作成先Thin Provisioning PoolのData Reductionが有効かつVolumeのData Reductionを無効にする設定をしていない場合、本項目は指定できません。

attention

integer

Default: 80

ホストセンスが報告されるUsed Rateの閾値。

単位は%です。

入力条件:

  • 指定可能な値は1~100です。

  • Volumeの作成先がThin Provisioning Poolである場合に限り、本設定項目を指定できます。

is_cm_encryption_enabled

boolean

Default: false

CMによる暗号化。

trueを指定した場合、Volume内のデータがCMによって暗号化されます。

入力条件:

  • Volumeの作成先がRAID Groupである場合に限り、本設定項目を指定できます。

    TPVの暗号化はThin Provisioning Poolの暗号化設定が反映されます。

  • 作成先RAID GroupがSAS HDD SED、SAS SSD SED、またはNVMe SSD SEDで構成されている場合、「"is_cm_encryption_enabled": true」は指定できません。

  • 装置の暗号化モードが有効な場合に限り、本設定項目を指定できます。

Responses

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

RESPONSE BODY

job_id

integer

Job ID。

job_href

string

JobのResourceへのLink。