Set virtual server preferred node
Each virtual server can have a preferred cluster node, to allow for load to be distributed around a cluster. The preferred nodes can be set all at once or individually.
HTTP request syntax (URI)
POST <base_URI>/v8/storage/virtual-servers/{virtualServerId}/preferred-node
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. |
nodeId | BODY | Y | string/number | Specifies either a node object ID or an HNAS storage cluster node ID. |
Return codes
Code | Data | Description |
204 | No Data | Virtual server preferred node successfully set. |
400 | Error Message | Missing or invalid request contents. |
403 | Error Message | Operation forbidden by access level. |
404 | Error Message | Requested resource not found. |
500 | Error message | Error associated with the storage system. |
Any HTTP status code other than 204 indicates that the API did not complete successfully.
Request example: Sets cluster node 2 as the preferred node 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/preferred-node -X POST '{"nodeId":2}'
Response example
HTTP/1.1 204 No Content