ListVolumes

ListVolumesメソッドを使用すると、クラスタ内のボリュームのリストを取得できます。パラメータを使用して、リストで返すボリュームを指定できます。

パラメータ

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

名前	説明	タイプ	デフォルト値	必須
accounts	ここで指定したアカウントが所有するボリュームのみが返されます。volumeIDsパラメータと同時に指定することはできません。	整数の配列	なし	×
includeVirtualVolumes	デフォルトでは仮想ボリュームは応答に含まれます。仮想ボリュームを除外するには、falseに設定します。	ブーリアン	true	×
isPaired	ペアリングされている（またはペアリングされていない）ボリュームを返します。有効な値は次のとおりです。 true：ペアリングされているすべてのボリュームを返します。 false：ペアリングされていないすべてのボリュームを返します。	ブーリアン	なし	×
limit	返されるボリューム数を設定できます。volumeIDsパラメータと同時に指定することはできません。	整数	10000	×
startVolumeID	IDの値が指定した値以上のボリュームのみが返されます。volumeIDsパラメータと同時に指定することはできません。	整数	なし	×
volumeIDs	ボリュームIDのリスト。このパラメータを指定すると、他のパラメータはこのパラメータで指定したボリュームに対してのみ適用されます。accounts、startVolumeID、およびlimitパラメータと同時に指定することはできません。	整数の配列	×	×
volumeName	ボリューム名が一致するボリュームのオブジェクト情報のみが返されます。	文字列	×	×
volumeStatus	ステータス値が一致するボリュームのみが返されます。有効な値は次のとおりです。 creating snapshotting active deleted	文字列	×	×

戻り値

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

名前	説明	タイプ
volumes	ボリュームのリスト。	volumeの配列

要求例

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

{
  "method": "ListVolumes",
    "params": {
        "volumeIDs": [1],
        "volumeStatus": "active",
        "isPaired": "false"
    },
    "id": 1
}

応答例

このメソッドの応答例を次に示します。

{
    "id": 1,
    "result": {
        "volumes": [
            {
                "access": "readWrite",
                "accountID": 1,
                "attributes": {},
                "blockSize": 4096,
                "createTime": "2016-03-28T14:39:05Z",
                "deleteTime": "",
                "enable512e": true,
                "iqn": "iqn.2010-01.com.solidfire:testvolume1.1",
                "name": "testVolume1",
                "purgeTime": "",
                "qos": {
                    "burstIOPS": 15000,
                    "burstTime": 60,
                    "curve": {
                        "4096": 100,
                        "8192": 160,
                        "16384": 270,
                        "32768": 500,
                        "65536": 1000,
                        "131072": 1950,
                        "262144": 3900,
                        "524288": 7600,
                        "1048576": 15000
                    },
                    "maxIOPS": 15000,
                    "minIOPS": 50
                },
                "scsiEUIDeviceID": "6a79617900000001f47acc0100000000",
                "scsiNAADeviceID": "6f47acc1000000006a79617900000001",
                "sliceCount": 1,
                "status": "active",
                "totalSize": 5000658944,
                "virtualVolumeID": null,
                "volumeAccessGroups": [],
                "volumeID": 1,
                "volumePairs": []
            }
        ]
    }
}