Retrieves detailed information about a virtual server on which a file system resides.
HTTP request syntax (URI)
GET <base_URI>/v7/storage/filesystems/{id}/virtual-servers
Parameters
| Name | Type | Required | Values | Description |
|---|---|---|---|---|
| id | URI_PARAM | Y | string | Either file system object ID or HNAS storage file system ID. |
Return codes
| Code | Data | Description |
|---|---|---|
| 200 | virtualServer | Virtual server object retrieved successfully. |
| 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 file system object ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/filesystems/3836363236374331323541433731414230303030303030303030303030303030/virtual-servers
Response example: Using the file system object ID
HTTP/1.1 200 OK
{
"virtualServer" :
{
"UUID" : "b70d82b2-0386-11d0-9043-49e1bb864b23",
"ipAddresses" :
[
"172.17.58.122"
],
"isEnabled" : true,
"name" : "xyz-evs-58-122",
"objectId" : "333a3a3a3a3a3a303a3a3a4f49445f24232140255f56",
"status" : "ONLINE",
"type" : "File services",
"virtualServerId" : 3
}
}
Request example: Using the HNAS storage file system ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/filesystems/866267C125AC71AB0000000000000000/virtual-servers
Response example: Using the HNAS storage file system ID
HTTP/1.1 200 OK
{
"virtualServer" :
{
"UUID" : "b70d82b2-0386-11d0-9043-49e1bb864b23",
"ipAddresses" :
[
"172.17.58.122"
],
"isEnabled" : true,
"name" : "xyz-evs-58-122",
"objectId" : "333a3a3a3a3a3a303a3a3a4f49445f24232140255f56",
"status" : "ONLINE",
"type" : "File services",
"virtualServerId" : 3
}
}