12.4.1　ボリュームの情報を取得する : Hitachi Storage Advisor Embedded ガイド

実行権限

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

リクエストライン

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

リクエストメッセージ

オブジェクトID: なし。

クエリパラメータ

1回のリクエストで取得できるボリュームの情報は最大で500個です。501個以上のボリュームの情報を取得する場合は、countパラメータとstartVolumeIdパラメータを組み合わせて複数回に分けてAPIを実行してください。countパラメータを指定することで取得するボリュームの情報をフィルタリングすることもできます。

パラメータ	型	フィルタ条件
poolId	int	（任意）ボリュームが属するプールID `poolName`と同時に指定しないでください。
poolName	string	（任意）ボリュームが属するプール名指定した値の一部がプール名と一致する場合もボリュームの情報が取得されます。 `poolId`と同時に指定しないでください。`poolId`を指定している場合、このパラメータは無視されます。
nickname	string	（任意）ボリュームのニックネーム指定した値の一部がボリュームのニックネームと一致する場合もボリュームの情報が取得されます。
minTotalCapacity	long	（任意）ボリュームの最小容量（MiB）
maxTotalCapacity	long	（任意）ボリュームの最大容量（MiB）
minUsedCapacity	long	（任意）ボリュームの最小使用容量（MiB）
maxUsedCapacity	long	（任意）ボリュームの最大使用容量（MiB）
startVolumeId	int	（任意）取得を開始するボリュームのIDを`0`～`65279`の値で指定します。
count	int	（任意）取得するボリュームの情報の個数を`1`～`500`の値で指定します。このパラメータを省略した場合、`500`が指定されたと見なされます。

ボディ: なし。

レスポンスメッセージ

ボディ

プールIDが63のプール（クエリパラメータpoolIdに63を指定）に属するボリュームの情報を取得した出力例を次に示します。

{
  "data": [
    {
      "id": 100,
      "nickname": "JH-26216_DP",
      "poolId": 63,
      "poolName": "NASOS",
      "totalCapacity": 1024,
      "usedCapacity": 42,
      "numberOfConnectingServers": 2,
      "numberOfSnapshots": 2,
      "volumeTypes": []
    },
    {
      "id": 101,
      "nickname": "JH-26216_DP",
      "poolId": 63,
      "poolName": "NASOS",
      "totalCapacity": 1024,
      "usedCapacity": 0,
      "numberOfConnectingServers": 2,
      "numberOfSnapshots": 2,
      "volumeTypes": [
        "Snapshot"
      ]
    }
  ],
  "count": 2,
  "totalCount": 2,
  "hasNext": false
}

属性	型	説明
id	int	ボリュームID
nickname	string	ニックネーム
poolId	int	ボリュームが属するプールID
poolName	string	ボリュームが属するプール名
totalCapacity	long	ボリュームの総容量（MiB）
usedCapacity	long	ボリュームの使用済み容量（MiB）
numberOfConnectingServers	int	現在、無効な情報です。
numberOfSnapshots	int	スナップショットの数
volumeTypes	object[]	ボリュームタイプ `Snapshot`：ボリュームIDが定義されているスナップショットの作成先ボリューム `System`：重複排除用システムデータボリュームまたはジャーナルボリューム `Command Device`：コマンドデバイスとして使用しているボリューム `SLU`：SLU（Subsidiary Logical Unit）属性を持つボリューム `AttachedUnmanaged`：ほかのツールで割り当て済みのボリューム

ステータスコード

この操作のリクエストに対するステータスコードについては、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/volumes?poolId=63

12.4.1 ボリュームの情報を取得する

12.4.1　ボリュームの情報を取得する