ListVolumes

您可以使用 ListVolumes 方法获取集群中所含卷的列表。可以使用可用参数来指定要在列表中返回的卷。

参数

此方法具有以下输入参数:

名称 说明 类型 默认值 必需
accounts 只会返回由此处指定的帐户拥有的卷。与 volumeIDs 参数不能共存。 整型数组
includeVirtualVolumes 默认情况下,响应中包含虚拟卷。要排除虚拟卷,请设置为 false 布尔型 true
isPaired 返回已配对或未配对的卷。可能值:
  • true:返回所有已配对的卷。
  • false:返回所有未配对的卷。
布尔型
limit 用于设置返回结果中包含的最大卷数。与 volumeIDs 参数不能共存。 整型 10000
startVolumeID 只会返回其 ID 大于或等于此值的卷。与 volumeIDs 参数不能共存。 整型
volumeIDs 卷 ID 列表。如果指定此参数,则其他参数仅对这组卷起作用。与 accountsstartVolumeIDlimit 参数不能共存。 整型数组
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": []
            }
        ]
    }
}