Cosmic Admin API Reference

createLBHealthCheckPolicy

Creates a load balancer health check policy

Request parameters

Parameter NameDescriptionRequired
lbruleidthe ID of the load balancer ruletrue
descriptionthe description of the load balancer health check policyfalse
fordisplayan optional field, whether to the display the rule to the end user or notfalse
healthythresholdNumber of consecutive health check success before declaring an instance healthyfalse
intervaltimeAmount of time between health checks (1 sec - 20940 sec)false
pingpathHTTP ping pathfalse
responsetimeoutTime to wait when receiving a response from the health check (2sec - 60 sec)false
unhealthythresholdNumber of consecutive health check failures before declaring an instance unhealthyfalse

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.