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)
取得するボリュームの最小容量として47~268435456までの整数で指定します。
maxTotalCapacity
long
(任意)ボリュームの最大容量(MiB)
取得するボリュームの最大容量として47~268435456までの整数で指定します。
minUsedCapacity
long
(任意)ボリュームの最小使用容量(MiB)
取得するボリュームの最小使用容量として0~268435456までの整数で指定します。
maxUsedCapacity
long
(任意)ボリュームの最大使用容量(MiB)
取得するボリュームの最大使用容量として0~268435456までの整数で指定します。
startVolumeId
int
(任意)取得を開始するボリュームのIDを0~65279の値で指定します。
count
int
(任意)取得するボリュームの情報の個数を1~500の値で指定します。
このパラメータを省略した場合、500が指定されたと見なされます。
- ボディ
- なし。
レスポンスメッセージ
- ボディ
-
プールIDが63のプール(クエリパラメータpoolIdに63を指定)に属するボリュームの情報を取得した出力例を次に示します。
{ "data": [ { "id": 3, "nickname": "JH-26216_DP", "poolId": 63, "poolName": "pool-1", "totalCapacity": 1024, "usedCapacity": 42, "savingSetting": "COMPRESSION", "compressionAcceleration": true, "capacitySavingStatus": "Enabled", "numberOfConnectingServers": 0, "numberOfSnapshots": 0, "volumeTypes": [] }, { "id": 4, "nickname": "JH-26216_DP", "poolId": 63, "poolName": "pool-1", "totalCapacity": 1024, "usedCapacity": 42, "savingSetting": "DISABLE", "capacitySavingStatus": "Disabled", "numberOfConnectingServers": 0, "numberOfSnapshots": 0, "volumeTypes": [] } ], "count": 2, "totalCount": 2, "hasNext": false }
属性
型
説明
id
int
ボリュームID
nickname
string
ニックネーム
poolId
int
ボリュームが属するプールID
poolName
string
ボリュームが属するプール名
ボリュームを作成中または削除中の場合、この属性は出力されません。
totalCapacity
long
ボリュームの総容量(MiB)
usedCapacity
long
ボリュームの使用済み容量(MiB)
ボリュームを作成中または削除中の場合、0が出力されます。
savingSetting
string
容量削減機能(圧縮および重複排除機能)の適用状況
- DEDUPLICATION_AND_COMPRESSION:圧縮および重複排除が有効
- COMPRESSION:圧縮が有効
- DISABLE:設定なし
compressionAcceleration
boolean
圧縮アクセラレータの適用状況
- true:有効
- false:無効
ストレージシステムがVSP E シリーズの場合で、容量削減機能が有効なボリュームのときに出力されます。
capacitySavingStatus
string
容量削減機能(圧縮および重複排除機能)の状態
- Disabled:容量削減機能が無効
- Enabled:容量削減機能が有効
- Rehydrating:容量削減機能を無効化中(データ伸長中)
- Enabling:容量削減機能を有効化中
- Deleting:容量削減機能が有効なボリュームを削除中
- Converting:容量削減機能の圧縮方式を変更中
- Failed:重複排除用システムデータボリューム内のデータが不正な状態
numberOfConnectingServers
int
ボリュームと接続している、Storage Advisor Embeddedで管理しているサーバの数
numberOfSnapshots
int
スナップショットの数
volumeTypes
string[]
ボリュームタイプ
- Snapshot:ボリュームIDが定義されているスナップショットの作成先ボリューム
- System:重複排除用システムデータボリュームまたはジャーナルボリューム
- Command Device:コマンドデバイスとして使用しているボリューム
- SLU:SLU(Subsidiary Logical Unit)属性を持つボリューム
- Attached Unmanaged:ほかのツールで割り当て済みのボリューム
- Namespace:Namespaceとして使用しているボリューム
ステータスコード
この操作のリクエストに対するステータスコードについては、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