Hitachi

Hitachi Storage Advisor Embedded ガイド 


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

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

実行権限

ストレージ管理者(参照)

リクエストライン

GET <ベースURL>/simple/v1/objects/volumes

リクエストメッセージ

オブジェクトID
なし。
クエリパラメータ

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

パラメータ

フィルタ条件

poolId

int

(任意)ボリュームが属するプールID

poolNameと同時に指定しないでください。

poolName

string

(任意)ボリュームが属するプール名

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

poolIdと同時に指定しないでください。poolIdを指定している場合、このパラメータは無視されます。

serverId

int

(任意)ボリュームが割り当てられているサーバID

serverNicknameと同時に指定しないでください。

serverNickname

string

(任意)ボリュームが割り当てられているサーバのニックネーム

指定した値の一部がサーバのニックネームと一致する場合もボリュームの情報が取得されます。

serverIdと同時に指定しないでください。serverIdを指定している場合、このパラメータは無視されます。

nickname

string

(任意)ボリュームのニックネーム

指定した値の一部がボリュームのニックネームと一致する場合もボリュームの情報が取得されます。

minTotalCapacity

long

(任意)ボリュームの最小容量(MiB)

取得するボリュームの最小容量として47268435456までの整数で指定します。

maxTotalCapacity

long

(任意)ボリュームの最大容量(MiB)

取得するボリュームの最大容量として47268435456までの整数で指定します。

minUsedCapacity

long

(任意)ボリュームの最小使用容量(MiB)

取得するボリュームの最小使用容量として0268435456までの整数で指定します。

maxUsedCapacity

long

(任意)ボリュームの最大使用容量(MiB)

取得するボリュームの最大使用容量として0268435456までの整数で指定します。

startVolumeId

int

(任意)取得を開始するボリュームのIDを065279の値で指定します。

count

int

(任意)取得するボリュームの情報の個数を1500の値で指定します。

このパラメータを省略した場合、500が指定されたと見なされます。

ボディ
なし。

レスポンスメッセージ

ボディ

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

{
  "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)

ボリュームを作成中または削除中の場合、0が出力されます。

numberOfConnectingServers

int

ボリュームと接続している、Storage Advisor Embeddedで管理しているサーバの数

numberOfSnapshots

int

スナップショットの数

volumeTypes

object[]

ボリュームタイプ

  • Snapshot:ボリュームIDが定義されているスナップショットの作成先ボリューム
  • System:重複排除用システムデータボリュームまたはジャーナルボリューム
  • Command Device:コマンドデバイスとして使用しているボリューム
  • SLU:SLU(Subsidiary Logical Unit)属性を持つボリューム
  • Attached Unmanaged:ほかのツールで割り当て済みのボリューム

ステータスコード

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