Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace HealthChecker

The health check policy configuration. For more information, see Editing Health Check Policies.

Properties

Optional intervalInMillis

intervalInMillis: undefined | number

The interval between health checks, in milliseconds. The default is 10000 (10 seconds).

Example: {@code 10000} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional isForcePlainText

isForcePlainText: undefined | false | true

Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL.

If \"true\", health checks will be done using plain text even if the associated backend set is configured to use SSL.

If \"false\", health checks will be done using SSL encryption if the associated backend set is configured to use SSL. If the backend set is not so configured the health checks will be done using plain text.

Example: {@code false}

port

port: number

The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the {@code Backend} object.

Example: {@code 8080} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

protocol

protocol: string

The protocol the health check must use; either HTTP or TCP.

Example: {@code HTTP}

responseBodyRegex

responseBodyRegex: string

A regular expression for parsing the response body from the backend server.

Example: {@code ^((?!false).|\\s)*$}

Optional retries

retries: undefined | number

The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. Defaults to 3.

Example: {@code 3} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

returnCode

returnCode: number

The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, you can use common HTTP status codes such as "200".

Example: {@code 200} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional timeoutInMillis

timeoutInMillis: undefined | number

The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. Defaults to 3000 (3 seconds).

Example: {@code 3000} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional urlPath

urlPath: undefined | string

The path against which to run the health check.

Example: {@code /healthcheck}

Functions

getDeserializedJsonObj

getJsonObj