Get Load Deprecated
Get load health.
Request
URLURL
https://{api_host}/rest/appliance/health/load
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
HealthLoadGetResponseBody of type application/json
Load health.
{
"value": "orange"
}
value
Optional
Load.HealthLevel enumerated type Defines health levels.
orange : The service health is degraded. The service might have serious problems.
gray : No health data is available for this service.
green : Service is healthy.
red : The service is unavaiable, not functioning properly, or will stop functioning soon.
yellow : The service is healthy state, but experiencing some levels of problems.
Possible values are: orange , gray , green , red , yellow
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/appliance/health/load
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: get
x-vmw-doc-new-path: /api/appliance/health/load
x-vmw-doc-operation: get
