14.2.1　プールの情報を取得する

実行権限

ストレージ管理者（参照）

リクエストライン

GET ＜ベースURL＞/simple/v1/objects/pools

リクエストメッセージ

オブジェクトID

なし。

クエリパラメータ

パラメータ	型	フィルタ条件
name	string	（任意）プール名 指定した値の一部がプール名と一致する場合もプールの情報が取得されます。
status	string	（任意）取得するプールの状態として、次の値を指定します。 Normal：正常 ExceededThreshold：プールの使用率がしきい値を超えている Error：プールが満杯でエラー状態
configStatus	string	（任意）取得するプールを構成するボリュームの状態として、PartiallyBlocked（プールを構成するボリュームが一部閉塞している）を指定します。

ボディ

なし。

レスポンスメッセージ

ボディ

{
    "data": [
        {
            "id": 1,
            "name": "DpPool_001",
            "status": "Normal",
            "encryption": "DISABLED",
            "totalCapacity": 10240,
            "usedCapacity": 0,
            "freeCapacity": 10240,
            "capacityManage": {
                "usedCapacityRate": 0,
                "thresholdWarning": 70,
                "thresholdDepletion": 80
            },
            "savingEffects": {
                "efficiencyDataReduction": 220,
                "efficiencyFmdSaving": 120,
                "preCapacityFmdSaving": 0,
                "postCapacityFmdSaving": 0,
                "isTotalEfficiencySupport": true,
                "totalEfficiencyStatus": "Valid",
                "dataReductionWithoutSystemDataStatus": "Valid",
                "softwareSavingWithoutSystemDataStatus": "Valid",
                "totalEfficiency": 12345,
                "dataReductionWithoutSystemData": 102,
                "softwareSavingWithoutSystemData": 103,
                "calculationStartTime": "2022-02-24T08:42:27Z",
                "calculationEndTime": "2022-02-24T08:52:27Z"
            },
            "configStatus": [],
            "numberOfVolumes": 25,
            "numberOfTiers": 0,
            "tiers": [],
            "subscriptionLimit": {
                "isEnabled": false,
                "currentRate": 250
            },
            "containsCapacitySavingVolume": false
        },
        {
            "id": 0,
            "name": "DpPool_000",
            "status": "Normal",
            "encryption": "UNKNOWN_EXTERNAL_VOLUME",
            "totalCapacity": 20480,
            "usedCapacity": 0,
            "freeCapacity": 20480,
            "capacityManage": {
                "usedCapacityRate": 0,
                "thresholdWarning": 70,
                "thresholdDepletion": 80
            },
            "savingEffects": {
                "efficiencyDataReduction": 220,
                "efficiencyFmdSaving": 120,
                "preCapacityFmdSaving": 0,
                "postCapacityFmdSaving": 0,
                "isTotalEfficiencySupport": true,
                "totalEfficiencyStatus": "Valid",
                "dataReductionWithoutSystemDataStatus": "Valid",
                "softwareSavingWithoutSystemDataStatus": "Valid",
                "totalEfficiency": 12345,
                "dataReductionWithoutSystemData": 102,
                "softwareSavingWithoutSystemData": 103,
                "calculationStartTime": "2022-02-24T08:42:27Z",
                "calculationEndTime": "2022-02-24T08:52:27Z"
            },
            "configStatus": [],
            "numberOfVolumes": 50,
            "numberOfTiers": 2,
            "tiers": [
                {
                    "driveType": "Flash Drive",
                    "driveRpm": "NUMBER_0",
                    "totalCapacity": 10240,
                    "usedCapacity": 0
                },
                {
                    "driveType": "External Storage",
                    "driveRpm": "Middle",
                    "totalCapacity": 10240,
                    "usedCapacity": 0
                }
            ],
            "subscriptionLimit": {
                "isEnabled": false,
                "currentRate": 250
            },
            "containsCapacitySavingVolume": false
        },
        {
            "id": 2,
            "name": "DpPool_002",
            "status": "Normal",
            "encryption": "UNKNOWN_EXTERNAL_VOLUME",
            "totalCapacity": 10240,
            "usedCapacity": 0,
            "freeCapacity": 10240,
            "capacityManage": {
                "usedCapacityRate": 0,
                "thresholdWarning": 70,
                "thresholdDepletion": 80
            },
            "savingEffects": {
                "efficiencyDataReduction": 220,
                "efficiencyFmdSaving": 120,
                "preCapacityFmdSaving": 0,
                "postCapacityFmdSaving": 0,
                "isTotalEfficiencySupport": true,
                "totalEfficiencyStatus": "Valid",
                "dataReductionWithoutSystemDataStatus": "Valid",
                "softwareSavingWithoutSystemDataStatus": "Valid",
                "totalEfficiency": 12345,
                "dataReductionWithoutSystemData": 102,
                "softwareSavingWithoutSystemData": 103,
                "calculationStartTime": "2022-02-24T08:42:27Z",
                "calculationEndTime": "2022-02-24T08:52:27Z"
            },
            "configStatus": [],
            "numberOfVolumes": 25,
            "numberOfTiers": 0,
            "tiers": [],
            "subscriptionLimit": {
                "isEnabled": false,
                "currentRate": 250
            },
            "containsCapacitySavingVolume": false
        }
    ],
    "count": 3
}

属性	型	説明
id	int	プールID
name	string	プール名
status	string	プールの状態 Normal：正常 ExceededThreshold：プールの使用率がしきい値を超えている Error：プールが満杯でエラー状態
encryption	string	プールの暗号化状態 ENABLED：プールの暗号化が有効 DISABLED：プールの暗号化が無効 MIXED：暗号化の有効と無効が混在している UNKNOWN_EXTERNAL_VOLUME：プールに外部ボリュームがあるため、プールの暗号化の状態が不明 UNKNOWN：プールが閉塞しているためプールの暗号化の状態が不明 ストレージシステムがVSP E シリーズの場合に出力されます。
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が出力された場合、その値は無効な情報です。 ストレージシステムがVSP E シリーズの場合、無効な値を示す-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：不明 ストレージシステムがVSP E シリーズの場合、容量拡張機能による削減効果は含まれません。 softwareSavingWithoutSystemDataStatus（string） 容量削減機能（圧縮および重複排除機能）による、容量削減機能が有効なボリュームに対するプールの削減効果の状態 Valid：有効 NotSupported：未サポート CalculationInProgress：集計中 NoTargetData：集計対象のデータがない Unknown：不明 ストレージシステムがVSP E シリーズの場合だけ出力されます。 totalEfficiency（long）※2 プールに格納されているすべてのボリュームに対する合計効果の比率 削減後の値を100として計算した削減前の値が出力されます。 （例）6742（削減前）：100（削減後）の場合、「"totalEfficiency": 6742」と出力されます。 プールからボリュームを作成したあと、データが書き込まれる前は、最大値9223372036854775807が出力されます。 計算を開始した日時、および計算を終了した日時は、属性calculationStartTimeおよびcalculationEndTimeで確認できます。 次の場合、無効値を示す-1が出力されます。 属性isTotalEfficiencySupportがfalse 属性totalEfficiencyStatusがValid以外 dataReductionWithoutSystemData（long）※2 容量削減機能（圧縮および重複排除機能）および容量拡張機能によるプールの削減効果の比率 削減後の値を100として計算した削減前の値が出力されます。 （例）138（削減前）：100（削減後）の場合、「"dataReductionWithoutSystemData": 138」と出力されます。 ストレージシステムがVSP E シリーズの場合、容量拡張機能による削減効果は含まれません。 計算を開始した日時、および計算を終了した日時は、属性calculationStartTimeおよびcalculationEndTimeで確認できます。 次の場合、無効値を示す-1が出力されます。 属性isTotalEfficiencySupportがfalse 属性dataReductionWithoutSystemDataStatusがValid以外 softwareSavingWithoutSystemData（long）※2 容量削減機能（圧縮および重複排除機能）による、容量削減機能が有効なボリュームに対するプールの削減効果の比率 削減後の値を100として計算した削減前の値が出力されます。 （例）138（削減前）：100（削減後）の場合、「"softwareSavingWithoutSystemData": 138」と出力されます。 ストレージシステムがVSP E シリーズの場合だけ出力されます。 次の場合、無効値を示す-1が出力されます。 属性isTotalEfficiencySupportがfalse 属性softwareSavingWithoutSystemDataStatusが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）
subscriptionLimit	object	プールに関連付けられたボリュームの最大予約率に関する設定情報 ストレージシステムがVSP E シリーズの場合に出力されます。 isEnabled（boolean） 最大予約率の設定が有効かどうか true：有効 false：無効 falseの場合、最大予約率は無制限であることを示します。 limitRate（int） 最大予約率（％） 属性isEnabledがtrueの場合だけ出力されます。 currentRate（long） 現在の予約率（％） プールに関連付けられた次に示すデータの合計容量の割合 ストレージシステムが生成するメタデータやガベージデータ ボリューム スナップショット この属性に出力される値の計算式は一律切り捨てではないため、計算結果によっては小数点以下を切り上げた値が出力される場合があります。 値が0から1の間、または100から101の間の場合、小数点以下を切り上げた値が出力されます。それ以外の値の場合、小数点以下を切り捨てた値が出力されます。
containsCapacitySavingVolume	boolean	容量削減機能（圧縮および重複排除機能）が有効なボリュームがプールに含まれているかどうか true：含まれている false：含まれていない ストレージシステムがVSP E シリーズの場合に出力されます。

注※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