ListActiveVolumes

ListActiveVolumesメソッドを使用すると、現在システムにあるアクティブなボリュームのリストを取得できます。ボリュームのリストは、ボリュームID順にソートされます。複数のパート(ページ)に分けて取得することもできます。

パラメータ

このメソッドの入力パラメータは次のとおりです。

名前 説明 タイプ デフォルト値 必須
includeVirtualVolumes デフォルトでは仮想ボリュームは応答に含まれます。仮想ボリュームを除外するには、falseに設定します。 ブーリアン true 無効
startVolumeID 返される最初のボリュームID。このIDのボリュームが存在しない場合は、ID順で次に位置するボリュームがリストの先頭として使用されます。リストをページングするには、前の応答の最後のボリュームに「1」を加えたボリュームIDを渡します。 整数 0 無効
limit 返されるボリューム情報オブジェクトの最大数。0(ゼロ)はすべてのボリュームを返します(無制限)。 整数 (無制限) 無効

戻り値

このメソッドの戻り値は次のとおりです。

名前 説明 タイプ
ボリューム アクティブなボリュームのリスト。 volumeの配列

要求例

このメソッドの要求例を次に示します。

{
   "method": "ListActiveVolumes",
   "params": {
      "startVolumeID"  : 0,
      "limit" : 1000
   },
   "id" : 1
}

応答例

この応答例は長いため、補足のトピックに記載しています。

新規導入バージョン

9.6