Get a virtual server
Retrieves a virtual server in the system. A unique value identifies the virtual server.
HTTP request syntax (URI)
GET <base_URI>/v8/storage/virtual-servers/{virtualServerId}
Parameters
Name | Type | Required | Values | Description |
virtualServerId | URI_PARAM | Y | string/number | Specifies either the virtual server object ID or the HNAS storage virtual server ID. |
Return codes
Code | Data | Description |
200 | virtualServer | Virtual server successfully created. |
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: Using the virtual server object ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/virtual-servers/383a3a3a4f49445f24232140255f56
Response example: Using the virtual server object ID
HTTP/1.1 200 OK { "virtualServer": { "UUID": "6efbf72c-b287-11d1-901e-040400070206", "ipAddresses": [ "111.111.111.111" ], "isEnabled": true, "name": "testing", "objectId": "383a3a3a3a3a3a303a3a3a4f49445f24232140255f56", "status": "ONLINE", "type": "File services", "virtualServerId": 8 } }
Request example: Using the HNAS storage virtual server ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/virtual-servers/8
Response example: Using the HNAS storage virtual server ID
HTTP/1.1 200 OK { "virtualServer": { "UUID": "6efbf72c-b287-11d1-901e-040400070206", "ipAddresses": [ "111.111.111.111" ], "isEnabled": true, "name": "testing", "objectId": "383a3a3a3a3a3a303a3a3a4f49445f24232140255f56", "status": "ONLINE", "type": "File services", "virtualServerId": 8 } }