Volume設定の変更

PATCH /volume/{volume_id}

概要説明

指定されたVolumeの設定を変更します。

注意

  • 変更したい設定項目を複数指定することはできません。

  • 設定変更のJobがSuccessであっても、以下のような場合はVolumeの設定が変更されないことがあります。

    • 設定対象外のVolumeを指定した場合（例：Data Container VolumeをThick Provisioned Volumeに仕様とした場合）

    • Data MigrationやZero Reclamation動作などの処理が実行中の場合

    • テナントユーザーの場合、自テナントに属するVolumeの設定のみ変更できます。

リクエスト例

  • Volume ID 3300002 の名前を"sample#02"に変更する場合の例です。 
    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X PATCH "https://192.168.1.1:5665/api/v1/volume/3300002"
-d
'{"new_name":"sample#02"}'

レスポンス例

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

Parameters

PATH PARAMETERS

volume_id

(required)

integer

Volume ID。

REQUEST BODY

new_name

string

Volume名。

入力条件：

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

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

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

  • 以下のVolume名を付けることはできません。

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

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

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

boolean

Extreme Cache Pool設定。

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

入力条件：

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

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

  • VolumeのData Reductionが有効の場合、本項目は指定できません。
alua

string

ALUA (Asymmetric Logical Unit Access) 設定。

Access Path制御をVolume単位に変更したい場合に指定します。
項目 説明
Follow_Host_Response Host Response設定に従います。
ACTIVE_ACTIVE ACTIVE/ACTIVE応答します。
ACTIVE-ACTIVE_PREFERRED_PATH ACTIVE-ACTIVE/PREFERRED PATH応答します。

入力条件：

  • Mappingが作成できないVolume (UsageがSystem, VVOL or ODXのVolume, SDPV, Temporary Volume) の場合は設定できません。
is_thick_provisioned

boolean

Allocation方式がThickがどうか。

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

falseを指定した場合、本API実行後に当該Volumeの容量最適化を実施すると未使用の物理領域が解放されます。

入力条件：

  • Volumeの種別がTPVまたはFTVである場合に限り、本設定項目を指定できます。

  • Data Reductionが有効なTPVの場合、設定変更することはできません。

  • UsageがSystemのVolumeの場合、設定変更することはできません。

  • Volumeが属するThin Provisioning Poolの未使用容量がVolumeのSizeより小さい場合、ThinからThickへの変更は失敗します。

  • 当該Volumeに以下の操作を実施中はエラー終了します。

    • RAID Migration

    • TPV/FTRP平準化

    • 容量最適化(ThinからThickへの変更時のみ)

  • Volumeが属するThin Provisioning PoolまたはFlexible Tier PoolのStatusがBrokenの場合は、本機能は実行できません。
attention

integer

ホストセンスが報告される使用率の閾値。

単位は%です。

入力条件：

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

  • Volumeの種別がTPVまたはFTVの場合に限り、本設定項目を指定できます。

Responses

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

RESPONSE BODY

job_id

integer

Job ID。
job_href

string

JobのResourceへのLink。