Retrieves a virtual server in the system. A unique value identifies the virtual server.
HTTP request syntax (URI)
GET <base_URI>/v7/storage/virtual-servers/{id}
Parameters
| Name | Type | Required | Values | Description |
|---|---|---|---|---|
| id | 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 | No Data | Missing or invalid request contents. |
| 404 | Error Message | Requested resource not found. |
| 500 | Error message | Error associated with the storage system. |
| 501 | No Data | Server has not implemented the request operation on the resource. |
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/v7/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" : "383a3a3a4f49445f24232140255f56",
"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/v7/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" : "testing1",
"objectId" : "383a3a3a4f49445f24232140255f56",
"status" : "ONLINE",
"type" : "File services",
"virtualServerId" : 8
}
}