Get IP address details for a virtual server
Gets all IP addresses of a virtual server, with associated details.
HTTP request syntax (URI)
GET <base_URI>/v8/storage/virtual-servers/{virtualServerId}/ip-address-details
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 | ipAddressDetails | IP address details 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: Get IP address details for virtual server 1
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/virtual-servers/1/ip-address-details
Response example
HTTP/1.1 200 OK
{
"ipAddressDetails": [
{
"cidr": "/18",
"ipAddress": "172.27.5.12",
"netmask": "255.255.192.0",
"port": "ag1"
},
{
"cidr": "/18",
"ipAddress": "172.27.5.14",
"netmask": "255.255.192.0",
"port": "ag1"
},
{
"cidr": "/64",
"ipAddress": "fdca:f995:220a:480:1:1:22:0",
"netmask": "/64",
"port": "ag1"
}
]
}