14.2.1 プールの情報を取得する
プールに関する情報を取得します。プールの条件を指定して、絞り込んだ情報を取得することもできます。
実行権限
ストレージ管理者(参照)
リクエストライン
GET <ベースURL>/simple/v1/objects/pools
リクエストメッセージ
- オブジェクトID
- なし。
- クエリパラメータ
-
パラメータ
型
フィルタ条件
name
string
(任意)プール名
指定した値の一部がプール名と一致する場合もプールの情報が取得されます。
status
string
(任意)取得するプールの状態として、次の値を指定します。
- Normal:正常
- ExceededThreshold:プールの使用率がしきい値を超えている
- Error:プールが満杯でエラー状態
configStatus
string
(任意)取得するプールを構成するボリュームの状態として、PartiallyBlocked(プールを構成するボリュームが一部閉塞している)を指定します。
- ボディ
- なし。
レスポンスメッセージ
- ボディ
-
{ "data": [ { "id": 4, "name": "Pool5_External", "status": "Normal", "totalCapacity": 20480, "usedCapacity": 0, "freeCapacity": 20480, "capacityManage": { "usedCapacityRate": 0, "thresholdWarning": 70, "thresholdDepletion": 80 }, "savingEffects": { "efficiencyDataReduction": 220, "efficiencyFmdSaving": 12345, "preCapacityFmdSaving": 0, "postCapacityFmdSaving": 0, "isTotalEfficiencySupport": true, "totalEfficiencyStatus": "Valid", "dataReductionWithoutSystemDataStatus": "Valid", "totalEfficiency": 12345, "dataReductionWithoutSystemData": 220 }, "configStatus": [], "numberOfVolumes": 0, "numberOfTiers": 0, "tiers": [] }, { "id": 3, "name": "Pool4", "status": "Normal", "totalCapacity": 65536000, "usedCapacity": 0, "freeCapacity": 65536000, "capacityManage": { "usedCapacityRate": 0, "thresholdWarning": 70, "thresholdDepletion": 80 }, "savingEffects": { "efficiencyDataReduction": 220, "efficiencyFmdSaving": 12345, "preCapacityFmdSaving": 0, "postCapacityFmdSaving": 0, "isTotalEfficiencySupport": true, "totalEfficiencyStatus": "Valid", "dataReductionWithoutSystemDataStatus": "Valid", "totalEfficiency": 12345, "dataReductionWithoutSystemData": 220 }, "configStatus": [], "numberOfVolumes": 50, "numberOfTiers": 0, "tiers": [] }, { "id": 2, "name": "Pool3", "status": "Normal", "totalCapacity": 9830400, "usedCapacity": 81920, "freeCapacity": 9748480, "capacityManage": { "usedCapacityRate": 1, "thresholdWarning": 70, "thresholdDepletion": 80 }, "savingEffects": { "efficiencyDataReduction": 220, "efficiencyFmdSaving": 12345, "preCapacityFmdSaving": 0, "postCapacityFmdSaving": 0, "isTotalEfficiencySupport": true, "totalEfficiencyStatus": "Valid", "dataReductionWithoutSystemDataStatus": "Valid", "totalEfficiency": 12345, "dataReductionWithoutSystemData": 220 }, "configStatus": [], "numberOfVolumes": 50, "numberOfTiers": 0, "tiers": [] }, { "id": 1, "name": "Pool2", "status": "Normal", "totalCapacity": 26214400, "usedCapacity": 0, "freeCapacity": 26214400, "capacityManage": { "usedCapacityRate": 0, "thresholdWarning": 70, "thresholdDepletion": 80 }, "savingEffects": { "efficiencyDataReduction": 220, "efficiencyFmdSaving": 12345, "preCapacityFmdSaving": 617, "postCapacityFmdSaving": 4, "isTotalEfficiencySupport": true, "totalEfficiencyStatus": "Valid", "dataReductionWithoutSystemDataStatus": "Valid", "totalEfficiency": 12345, "dataReductionWithoutSystemData": 220 }, "configStatus": [], "numberOfVolumes": 50, "numberOfTiers": 2, "tiers": [ { "driveType": "Flash Drive", "driveRpm": "NUMBER_0", "totalCapacity": 16384000, "usedCapacity": 0 }, { "driveType": "HDD", "driveRpm": "NUMBER_10000", "totalCapacity": 9830400, "usedCapacity": 0 } ] } ], "count": 4 }
属性
型
説明
id
int
プールID
name
string
プール名
status
string
プールの状態
- Normal:正常
- ExceededThreshold:プールの使用率がしきい値を超えている
- Error:プールが満杯でエラー状態
totalCapacity
long
プールの総容量(MiB)
usedCapacity
long
プールの使用容量(MiB)
freeCapacity
long
プールの空き容量(MiB)
capacityManage
object
プールの容量に関する設定情報が出力されます。
- usedCapacityRate(int)
プールの使用率(%)
- thresholdWarning(int)
プールの警告しきい値(%)
- thresholdDepletion(int)
プールの枯渇しきい値(%)
savingEffects
object
プールに関する削減効果の比率などの情報が出力されます。
- efficiencyDataReduction(int)※1
容量削減機能(圧縮および重複排除機能)によって削減されたプールの削減効果の比率
削減後の値を100として計算した削減前の値が出力されます。
(例)105(削減前):100(削減後)の場合、「"efficiencyDataReduction": 105」と出力されます。
-1が出力された場合、その値は無効な情報です。
- efficiencyFmdSaving(int)
容量拡張機能によって削減されたプールの削減効果の比率
削減後の値を100として計算した削減前の値が出力されます。
(例)105(削減前):100(削減後)の場合、「"efficiencyFmdSaving": 105」と出力されます。
-1が出力された場合、その値は無効な情報です。
- preCapacityFmdSaving(long)
容量拡張機能によって削減される前のプールの容量
属性efficiencyFmdSavingに無効な値-1が出力されている場合、この属性には0が出力されます。
- postCapacityFmdSaving(long)
容量拡張機能によって削減された後のプールの容量
属性efficiencyFmdSavingに無効な値-1が出力されている場合、この属性には0が出力されます。
- isTotalEfficiencySupport(boolean)
合計効果をサポートしているかどうかが出力されます。
- true:サポート
- false:未サポート
- totalEfficiencyStatus(string)
プールに格納されているすべてのボリュームに対する合計効果の状態
- Valid:有効
- NotSupported:未サポート
- CalculationInProgress:集計中
- NoTargetData:集計対象のデータがない
- Unknown:不明
- dataReductionWithoutSystemDataStatus(string)
容量削減機能(圧縮および重複排除機能)および容量拡張機能によるプールの削減効果の状態
- Valid:有効
- NotSupported:未サポート
- CalculationInProgress:集計中
- NoTargetData:集計対象のデータがない
- Unknown:不明
- totalEfficiency(long)※2
プールに格納されているすべてのボリュームに対する合計効果の比率
削減後の値を100として計算した削減前の値が出力されます。
(例)6742(削減前):100(削減後)の場合、「"totalEfficiency": 6742」と出力されます。
プールからボリュームを作成したあと、データが書き込まれる前は、最大値9223372036854775807が出力されます。
計算を開始した日時、および計算を終了した日時は、属性calculationStartTimeおよびcalculationEndTimeで確認できます。
次の場合、無効値を示す-1が出力されます。
- 属性isTotalEfficiencySupportがfalse
- 属性totalEfficiencyStatusがValid以外
- dataReductionWithoutSystemData(long)※2
容量削減機能(圧縮および重複排除機能)および容量拡張機能によるプールの削減効果の比率
削減後の値を100として計算した削減前の値が出力されます。
(例)138(削減前):100(削減後)の場合、「"dataReductionWithoutSystemData": 138」と出力されます。
計算を開始した日時、および計算を終了した日時は、属性calculationStartTimeおよびcalculationEndTimeで確認できます。
次の場合、無効値を示す-1が出力されます。
- 属性isTotalEfficiencySupportがfalse
- 属性dataReductionWithoutSystemDataStatusがValid以外
- calculationStartTime(ISO8601string)
計算を開始した日時(UTC)がYYYY-MM-DDThh:mm:ssZ形式で出力されます。
- calculationEndTime(ISO8601string)
計算を終了した日時(UTC)がYYYY-MM-DDThh:mm:ssZ形式で出力されます。
configStatus
string[]
プールを構成するボリュームの状態
- PartiallyBlocked:プールを構成するボリュームが一部閉塞している
numberOfVolumes
int
プールに関連づけられたボリュームの数
numberOfTiers
int
プールを構成する階層の数
tiers
object[]
階層に関する次の属性が、階層ごとに出力されます。
- driveType(string)
次に示すドライブタイプが出力されます。
- Flash Drive
- HDD
- External Storage
- Mixed
- Unknown
- driveRpm(string)
ドライブの毎分回転数
- totalCapacity(long)
階層の総容量(MiB)
- usedCapacity(long)
階層の使用済み容量(MiB)
- 注※1
- ユーザデータのほかにストレージシステムが生成するメタデータやガベージデータなどを含んだ値で計算します。そのため、削減後の値の方が大きくなることがあります。
- 注※2
- ストレージシステムが生成するメタデータやガベージデータなどは含まれません。
ステータスコード
この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。
コード例
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/pools