Get a virtual volume
Retrieves a virtual volume by its ID.
HTTP request syntax (URI)
GET <base_URI>/v8/storage/virtual-volumes/{virtualVolumeObjectId}
Parameters
| Name | Type | Required | Values | Description |
| virtualVolumeObjectId | URI_PARAM | Y | string | ID of the virtual volume object. |
Return codes
| Code | Data | Description |
| 200 | virtualVolume | Virtual volume successfully retrieved. |
| 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/virtual-volumes/353a3a3a37353431323730394531434239414142303030303030303030303030303030303a3a3a3136
Response example
HTTP/1.1 200 OK
{
"virtualVolume": {
"emails": [
"user1@example.com",
"user2@example.com"
],
"fileCount": 1,
"filesystemId": "7547FEE51E4FEC080000000000000000",
"objectId": "353a3a3a37353431323730394531434239414142303030303030303030303030303030303a3a3a3136",
"name": "xyz-doc-test-0426",
"path": "/xyzvirtualvolume/docTest",
"permanentId": 8451003485793545000,
"totalVolumeCapacity": 4982833152,
"usageVolumeCapacity": 0,
"virtualServerId": 5,
"virtualVolumeId": 12
}
}