7.7 ボリュームをフォーマットする
実行権限
ストレージ管理者(プロビジョニング)
リクエストライン
PUT <ベースURL>/v1/objects/storages/<ストレージデバイスID>/ldevs/<オブジェクトID>/actions/format/invoke
このAPIはPOSTメソッドでも実行できます。
リクエストメッセージ
- オブジェクトID
-
ボリュームの情報取得で取得したldevIdの値を指定します。
属性
型
説明
ldevId
int
(必須)LDEV番号を10進数で指定します。
- クエリパラメータ
- なし。
- ボディ
-
{ "parameters": { "operationType": "FMT" } }
属性
型
説明
operationType
string
(必須)フォーマット種別
指定できる値を次に示します。
FMT:通常のフォーマット
QFMT:クイックフォーマット
容量削減機能(dedupe and compression)が有効なDPボリュームの場合はFMTだけ指定できます。
レスポンスメッセージ
- ボディ
-
ジョブオブジェクトを返します。affectedResources以外の属性については、ジョブオブジェクトの説明を参照してください。
属性
説明
affectedResources
フォーマットしたボリュームのURL
Actionテンプレート
GET <ベースURL>/v1/objects/storages/<ストレージデバイスID>/ldevs/<オブジェクトID>/actions/format
ステータスコード
この操作のリクエストに対するステータスコードの意味を次に示します。そのほかのステータスコードについては、HTTPステータスコードの説明を参照してください。
ステータスコード |
メッセージ |
説明 |
---|---|---|
412 |
Precondition Failed |
ボリュームが次のどれかの条件を満たすため、指定されたアクションを実行できません。
|
コード例
Actionテンプレートを取得する場合
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/ldevs/1/actions/format
Actionテンプレートを取得してリクエストを実行する場合
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X PUT --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/ldevs/1/actions/format/invoke
容量削減機能(dedupe and compression)が有効なDPボリュームを強制的にフォーマットする場合
- 重要
-
重複排除されたデータのフォーマットには時間がかかります。計画的にフォーマットすることをお勧めします。容量削減機能(圧縮または重複排除)が有効なDPボリュームのフォーマットの詳細については、マニュアルシステム構築ガイドまたはオープンシステム構築ガイドを参照してください。また、フォーマットが完了したかどうかは、ジョブのステータスではなく対象のリソースの状態を取得して確認してください。
容量削減機能(圧縮または重複排除)が有効なDPボリュームのフォーマットは、リクエストボディでoperationType属性にFMT、isDataReductionForceFormat属性にtrueを指定します。
強制的にフォーマットする場合のコード例を次に示します。
{ "parameters": { "operationType": "FMT", "isDataReductionForceFormat": true } }
属性 |
型 |
説明 |
---|---|---|
isDataReductionForceFormat |
boolean |
(任意)容量削減機能(圧縮または重複排除)が有効なDPボリュームを強制的にフォーマットするかどうか
省略した場合、false が設定されたと見なされます。 |