LoadBalancerHealth

class oci.load_balancer.models.LoadBalancerHealth(**kwargs)

Bases: object

The health status details for the specified load balancer.

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

STATUS_CRITICAL = 'CRITICAL'

A constant which can be used with the status property of a LoadBalancerHealth. This constant has a value of "CRITICAL"

STATUS_OK = 'OK'

A constant which can be used with the status property of a LoadBalancerHealth. This constant has a value of "OK"

STATUS_UNKNOWN = 'UNKNOWN'

A constant which can be used with the status property of a LoadBalancerHealth. This constant has a value of "UNKNOWN"

STATUS_WARNING = 'WARNING'

A constant which can be used with the status property of a LoadBalancerHealth. This constant has a value of "WARNING"

__init__(**kwargs)

Initializes a new LoadBalancerHealth object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • status (str) -- The value to assign to the status property of this LoadBalancerHealth. Allowed values for this property are: "OK", "WARNING", "CRITICAL", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • warning_state_backend_set_names (list[str]) -- The value to assign to the warning_state_backend_set_names property of this LoadBalancerHealth.
  • critical_state_backend_set_names (list[str]) -- The value to assign to the critical_state_backend_set_names property of this LoadBalancerHealth.
  • unknown_state_backend_set_names (list[str]) -- The value to assign to the unknown_state_backend_set_names property of this LoadBalancerHealth.
  • total_backend_set_count (int) -- The value to assign to the total_backend_set_count property of this LoadBalancerHealth.
critical_state_backend_set_names

[Required] Gets the critical_state_backend_set_names of this LoadBalancerHealth. A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the friendly name you assigned when you created it.

Example: example_backend_set

Returns:The critical_state_backend_set_names of this LoadBalancerHealth.
Return type:list[str]
status

[Required] Gets the status of this LoadBalancerHealth. The overall health status of the load balancer.

  • OK: All backend sets associated with the load balancer return a status of OK.
  • WARNING: At least one of the backend sets associated with the load balancer returns a status of WARNING,

no backend sets return a status of CRITICAL, and the load balancer life cycle state is ACTIVE.

  • CRITICAL: One or more of the backend sets associated with the load balancer return a status of CRITICAL.

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

    • The load balancer life cycle state is not 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 UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the load balancer life cycle state is ACTIVE.
    • The system could not retrieve metrics for any reason.

Allowed values for this property are: "OK", "WARNING", "CRITICAL", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The status of this LoadBalancerHealth.
Return type:str
total_backend_set_count

[Required] Gets the total_backend_set_count of this LoadBalancerHealth. The total number of backend sets associated with this load balancer.

Example: 4

Returns:The total_backend_set_count of this LoadBalancerHealth.
Return type:int
unknown_state_backend_set_names

[Required] Gets the unknown_state_backend_set_names of this LoadBalancerHealth. A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the friendly name you assigned when you created it.

Example: example_backend_set2

Returns:The unknown_state_backend_set_names of this LoadBalancerHealth.
Return type:list[str]
warning_state_backend_set_names

[Required] Gets the warning_state_backend_set_names of this LoadBalancerHealth. A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the friendly name you assigned when you created it.

Example: example_backend_set3

Returns:The warning_state_backend_set_names of this LoadBalancerHealth.
Return type:list[str]