Get virtual volumes
Retrieves virtual volumes on a file system.
This API call has changed in version 8.
HTTP request syntax (URI)
GET <base_URI>/v8/storage/filesystems/{filesystemId}/virtual-volumes
Parameters
Name | Type | Required | Values | Description |
filesystemId | URI_PARAM | Y | string | Either the file system object ID or HNAS file system ID. |
Return codes
Code | Data | Description |
200 | virtualVolumes | Virtual volumes retrieved successfully. |
400 | Error Message | Missing or invalid request contents. |
404 | Error Message | Requested resource not found. |
500 | Error message | Error associated with the storage system. |
Any HTTP status code other than 200 indicates that the API did not complete successfully.
Request example
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.57.75:8444/v8/storage/filesystems/075EAD9FEFAB4EB90000000000000000/virtual-volumes
Response example
HTTP/1.1 200 OK { "virtualVolumes": [ { "emails": [ "dave@example.com" ], "fileCount": 1, "filesystemId": "075EAD9FEFAB4EB90000000000000000", "name": "vv1", "objectId": "313a3a3a30373545414439464546414234454239303030303030303030303030303030303a3a3a313a3a3a303a3a3a4f49445f24232140255f56", "path": "/vv1", "permanentId": 531052708508683970, "totalVolumeCapacity": 19310575616, "usageVolumeCapacity": 0, "virtualServerId": 1, "virtualVolumeId": 1 }, { "emails": [ "" ], "fileCount": 1, "filesystemId": "075EAD9FEFAB4EB90000000000000000", "name": "vv2", "objectId": "313a3a3a30373545414439464546414234454239303030303030303030303030303030303a3a3a323a3a3a303a3a3a4f49445f24232140255f56", "path": "/vv2", "permanentId": 531052708508683970, "totalVolumeCapacity": 19310575616, "usageVolumeCapacity": 0, "virtualServerId": 1, "virtualVolumeId": 2 } ] }