HealthCheck
The HealthCheck data type.
Relevant Operations
Contents
The following table describes the elements contained in HealthCheck.
| Name | Description | Required |
|---|---|---|
|
|
The number of consecutive health probe successes required before moving the instance to the Healthy state. The default is three and a valid value lies between two and ten. Type: HealthyThreshold |
Yes |
|
|
The approximate interval (in seconds) between health checks of an
individual instance. The default is 30 seconds and a valid interval must be between 5 seconds and 600 seconds.
Also, the interval value must be greater than the Type: HealthCheckInterval |
Yes |
|
|
The instance being checked. The protocol is either TCP or HTTP. The range of valid ports is one (1) through 65535. Notes: TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case a healthcheck simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy. For HTTP, the situation is different. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy. The total length of the HTTP ping target needs to be 1024 16-bit Unicode characters or less. Type: string |
Yes |
|
|
Amount of time (in seconds) during which no response means a failed health probe. The default is five
seconds and a valid value must be between 2 seconds and 60 seconds. Also, the timeout value must be less than the Type: HealthCheckTimeout |
Yes |
|
|
The number of consecutive health probe failures that move the instance to the unhealthy state. The default is 5 and a valid value lies between 2 and 10. Type: UnhealthyThreshold |
Yes |