Apache CloudStack v4.6.0 Domain Admin API Reference


Lists load balancer health check policies.

Request parameters

Parameter NameDescriptionRequired
fordisplaylist resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idthe ID of the health check policyfalse
keywordList by keywordfalse
lbruleidthe ID of the load balancer rulefalse

Response Tags

Response NameDescription
accountthe account of the HealthCheck policy
domainthe domain of the HealthCheck policy
domainidthe domain ID of the HealthCheck policy
lbruleidthe LB rule ID
zoneidthe id of the zone the HealthCheck policy belongs to
healthcheckpolicy(*)the list of healthcheckpolicies
idthe LB HealthCheck policy ID
descriptionthe description of the healthcheck policy
fordisplayis policy for display to the regular user
healthcheckintervalAmount of time between health checks
healthcheckthressholdNumber of consecutive health check success before declaring an instance healthy
pingpaththe pingpath of the healthcheck policy
responsetimeTime to wait when receiving a response from the health check
statethe state of the policy
unhealthcheckthressholdNumber of consecutive health check failures before declaring an instance unhealthy.