Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace LoadBalancerHealth

The health status details for the specified load balancer.

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

Properties

criticalStateBackendSetNames

criticalStateBackendSetNames: Array<string>

A list of backend sets that are currently in the {@code CRITICAL} health state. The list identifies each backend set by the friendly name you assigned when you created it.

Example: {@code example_backend_set}

status

status: Status

The overall health status of the load balancer.

**OK:** All backend sets associated with the load balancer return a status of {@code OK}.

**WARNING:** At least one of the backend sets associated with the load balancer returns a status of {@code WARNING}, no backend sets return a status of {@code CRITICAL}, and the load balancer life cycle state is {@code ACTIVE}.

**CRITICAL:** One or more of the backend sets associated with the load balancer return a status of {@code CRITICAL}.

**UNKNOWN:** If any one of the following conditions is true:

The load balancer life cycle state is not {@code ACTIVE}.

No backend sets are defined for the load balancer.

More than half of the backend sets associated with the load balancer return a status of {@code UNKNOWN}, none of the backend sets return a status of {@code WARNING} or {@code CRITICAL}, and the load balancer life cycle state is {@code ACTIVE}.

The system could not retrieve metrics for any reason.

totalBackendSetCount

totalBackendSetCount: number

The total number of backend sets associated with this load balancer.

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

unknownStateBackendSetNames

unknownStateBackendSetNames: Array<string>

A list of backend sets that are currently in the {@code UNKNOWN} health state. The list identifies each backend set by the friendly name you assigned when you created it.

Example: {@code example_backend_set2}

warningStateBackendSetNames

warningStateBackendSetNames: Array<string>

A list of backend sets that are currently in the {@code WARNING} health state. The list identifies each backend set by the friendly name you assigned when you created it.

Example: {@code example_backend_set3}

Functions

getDeserializedJsonObj

getJsonObj