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

プールに関する情報を取得します。プールの条件を指定して、絞り込んだ情報を取得することもできます。

実行権限

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

リクエストライン

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

リクエストメッセージ

オブジェクトID: なし。

クエリパラメータ

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

パラメータ

型

フィルタ条件

name

string

（任意）プール名

指定した値の一部がプール名と一致する場合もプールの情報が取得されます。

status

string

（任意）取得するプールの状態として、次の値を指定します。

Normal：正常
ExceededThreshold：プールの使用率がしきい値を超えている
Error：プールが満杯でエラー状態

configStatus

string

（任意）取得するプールを構成するボリュームの状態として、PartiallyBlocked（プールを構成するボリュームが一部閉塞している）を指定します。

ボディ: なし。

レスポンスメッセージ

ボディ

{
  "data": [
    {
      "id": 63,
      "name": "NASOS",
      "status": "Normal",
      "totalCapacity": 2996994,
      "usedCapacity": 38,
      "freeCapacity": 2996956,
      "capacityManage": {
        "usedCapacityRate": 0,
        "thresholdWarning": 70,
        "thresholdDepletion": 80
      },
      "savingEffects": {
        "efficiencyDataReduction": 105,
        "efficiencyFmdSaving": 0,
        "preCapacityFmdSaving": 0,
        "postCapacityFmdSaving": 0,
        "isTotalEfficiencySupport": true,
        "totalEfficiencyStatus": "Valid",
        "dataReductionWithoutSystemDataStatus": "Valid",
        "totalEfficiency": 6742,
        "dataReductionWithoutSystemData": 138,
        "calculationStartTime": "2018-09-28T07:41:58Z",
        "calculationEndTime": "2018-09-28T07:43:51Z"
      },
      "configStatus": [],
      "numberOfVolumes": 2,
      "numberOfTiers": 2,
      "tiers": [
        {
          "driveType": "Flash Drive",
          "driveRpm": "NUMBER_0",
          "totalCapacity": 1352148,
          "freeCapacity": 1352110
        },
        {
          "driveType": "SAS",
          "driveRpm": "NUMBER_10000",
          "totalCapacity": 1644846,
          "freeCapacity": 1644846
        }
      ]
    }
  ],
  "count": 1
}

属性	型	説明
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）容量拡張機能によって削減される前のプールの容量 `postCapacityFmdSaving`（long）容量拡張機能によって削減された後のプールの容量 `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`-`DD`T`hh`:`mm`:`ss`Z形式で出力されます。 `calculationEndTime`（ISO8601string）計算を終了した日時（UTC）が`YYYY`-`MM`-`DD`T`hh`:`mm`:`ss`Z形式で出力されます。
configStatus	string[]	プールを構成するボリュームの状態 `PartiallyBlocked`：プールを構成するボリュームが一部閉塞している
numberOfVolumes	int	プールに関連づけられたボリュームの数
numberOfTiers	int	プールを構成する階層の数
tiers	object[]	階層に関する次の属性が、階層ごとに出力されます。 `driveType`（string）次に示すドライブタイプが出力されます。 `Flash Drive` `SAS` `SATA` `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

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

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