Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace BackendSetHealth

The health status details for a backend set.

This object does not explicitly enumerate backend servers with a status of {@code OK}. However, they are included in the {@code totalBackendCount} sum.

Properties

criticalStateBackendNames

criticalStateBackendNames: Array<string>

A list of backend servers that are currently in the {@code CRITICAL} health state. The list identifies each backend server by IP address and port.

Example: {@code 10.0.0.4:8080}

status

status: Status

Overall health status of the backend set.

**OK:** All backend servers in the backend set return a status of {@code OK}.

**WARNING:** Half or more of the backend set's backend servers return a status of {@code OK} and at least one backend server returns a status of {@code WARNING}, {@code CRITICAL}, or {@code UNKNOWN}.

**CRITICAL:** Fewer than half of the backend set's backend servers return a status of {@code OK}.

**UNKNOWN:** More than half of the backend set's backend servers return a status of {@code UNKNOWN}, the system was unable to retrieve metrics, or the backend set does not have a listener attached.

totalBackendCount

totalBackendCount: number

The total number of backend servers in this backend set.

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

unknownStateBackendNames

unknownStateBackendNames: Array<string>

A list of backend servers that are currently in the {@code UNKNOWN} health state. The list identifies each backend server by IP address and port.

Example: {@code 10.0.0.5:8080}

warningStateBackendNames

warningStateBackendNames: Array<string>

A list of backend servers that are currently in the {@code WARNING} health state. The list identifies each backend server by IP address and port.

Example: {@code 10.0.0.3:8080}

Functions

getDeserializedJsonObj

getJsonObj