14.5.4 ボリュームの設定を変更する
ボリュームIDを指定して、ニックネームの変更や、容量削減機能(圧縮および重複排除機能)の設定を変更します。
実行権限
ストレージ管理者(プロビジョニング)
リクエストライン
PATCH <ベースURL>/simple/v1/objects/volumes/<オブジェクトID>
リクエストメッセージ
- オブジェクトID
-
ボリュームの情報取得で取得したidの値を指定します。
属性
型
説明
id
int
(必須)ボリュームID
- クエリパラメータ
- なし。
- ボディ
-
指定した属性だけが変更されます。
ニックネームを変更する例を次に示します。
{ "nickname": "REST_API_10GVolume" }
容量削減機能(圧縮および重複排除機能)の設定値を無効に変更する例を次に示します。
{ "savingSetting": "DISABLE" }
属性
型
説明
nickname
string
(任意)変更するニックネームを1~32文字で指定します。
使用できる文字は次のとおりです。
0~9 A~Z a~z ! # $ % & ' ( ) + , - . / : = @ [ \ ] ^ _ ` { } ~ 半角スペース
英字は、大文字と小文字が区別されます。
半角スペースは、使用できる文字と文字の間には使用できますが、先頭と末尾には使用できません。
この属性を指定する場合、savingSettingを同時に指定しないでください。
savingSetting
string
(任意)容量削減機能(圧縮および重複排除機能)の設定
- DEDUPLICATION_AND_COMPRESSION:圧縮および重複排除を有効にする
重複排除を有効にする場合、圧縮も有効となります。
- COMPRESSION:圧縮を有効にする
- DISABLE:設定しない
DEDUPLICATION_AND_COMPRESSIONをCOMPRESSIONに変更することはできません。
この属性を指定する場合、ボリュームの設定変更に時間が掛かることがあります。容量削減機能の詳細はマニュアルシステム構築ガイドを参照してください。
この属性を指定する場合、nicknameを同時に指定しないでください。
compressionAcceleration
boolean
(任意)圧縮アクセラレータの設定
- true:有効
- false:無効
ストレージシステムがVSP E1090、VSP E1090Hの場合に指定できます。
- この属性を省略した場合で、属性savingSettingの属性値をDISABLEからDISABLE以外に変更したときには、ストレージシステムによって自動で設定される値が変わります。
-
- 圧縮アクセラレータが使用できるとき:true
- 圧縮アクセラレータが使用できないとき:false
属性savingSettingにDISABLEを指定した場合、このパラメータの指定は無視されます。
この属性を指定する場合、nicknameを同時に指定しないでください。
- DEDUPLICATION_AND_COMPRESSION:圧縮および重複排除を有効にする
レスポンスメッセージ
- ボディ
-
- ニックネームを変更した場合
属性
型
説明
affectedResources
string[]
変更したボリュームの情報を参照するためのURLの一覧
operationDetails
object[]
変更したボリュームの詳細情報
詳細については、commandStatusオブジェクトの属性operationDetailsの説明を参照してください。
- 容量削減機能(圧縮および重複排除機能)の設定を変更した場合
属性
型
説明
statusResource
string
変更したボリュームの情報を参照するためのURL
- メモ
-
非同期処理のAPIのステータス情報を取得するAPIを実行して、実行結果のステータス情報を参照することもできます。詳細は非同期処理のAPIのステータス情報を取得するAPIの説明を参照してください。
- ニックネームを変更した場合
ステータスコード
この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。
コード例
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/simple/v1/objects/volumes/100