Get Cluster Mode
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Retrieves the current mode of a VCHA cluster.
Request
URLURL
https://{api_host}/rest/vcenter/vcha/cluster/mode
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
VchaClusterModeGetResponseBody
of type application/json
Info structure containing the mode of the the VCHA cluster.
{
"value": {
"mode": "enum"
}
}| Property Name | Type | Description |
|---|---|---|
| value | VchaClusterModeInfo |
Info structure containing the mode of the the VCHA cluster. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vcha/cluster/mode
Errors
| Code | Returns | Description |
|---|---|---|
| default | ErrorRest | Not available |
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthorized : If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege. |
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : If any other error occurs. |
| 409 | ErrorRest | com.vmware.vapi.std.errors.not_allowed_in_current_state : If the VCHA cluster is not configured. |
