Cosmic Admin API Reference

createLBHealthCheckPolicy

Creates a load balancer health check policy

Request parameters

Parameter Name	Description	Required
lbruleid	the ID of the load balancer rule	true
description	the description of the load balancer health check policy	false
fordisplay	an optional field, whether to the display the rule to the end user or not	false
healthythreshold	Number of consecutive health check success before declaring an instance healthy	false
intervaltime	Amount of time between health checks (1 sec - 20940 sec)	false
pingpath	HTTP ping path	false
responsetimeout	Time to wait when receiving a response from the health check (2sec - 60 sec)	false
unhealthythreshold	Number of consecutive health check failures before declaring an instance unhealthy	false

Response Tags

Response Name	Description
account	the account of the HealthCheck policy
domain	the domain of the HealthCheck policy
domainid	the domain ID of the HealthCheck policy
lbruleid	the LB rule ID
zoneid	the id of the zone the HealthCheck policy belongs to
*healthcheckpolicy()**	the list of healthcheckpolicies
id	the LB HealthCheck policy ID
description	the description of the healthcheck policy
fordisplay	is policy for display to the regular user
healthcheckinterval	Amount of time between health checks
healthcheckthresshold	Number of consecutive health check success before declaring an instance healthy
pingpath	the pingpath of the healthcheck policy
responsetime	Time to wait when receiving a response from the health check
state	the state of the policy
unhealthcheckthresshold	Number of consecutive health check failures before declaring an instance unhealthy.