BackendHealth

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

Bases: object

The health status of the specified backend server as reported by the primary and standby load balancers.

STATUS_CRITICAL = 'CRITICAL'

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

STATUS_OK = 'OK'

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

STATUS_UNKNOWN = 'UNKNOWN'

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

STATUS_WARNING = 'WARNING'

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

__init__(**kwargs)

Initializes a new BackendHealth 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 BackendHealth. 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'.
  • health_check_results (list[HealthCheckResult]) -- The value to assign to the health_check_results property of this BackendHealth.
health_check_results

[Required] Gets the health_check_results of this BackendHealth. A list of the most recent health check results returned for the specified backend server.

Returns:The health_check_results of this BackendHealth.
Return type:list[HealthCheckResult]
status

[Required] Gets the status of this BackendHealth. The general health status of the specified backend server as reported by the primary and standby load balancers.

  • OK: Both health checks returned OK.
  • WARNING: One health check returned OK and one did not.
  • CRITICAL: Neither health check returned OK.
  • UNKNOWN: One or both health checks returned UNKNOWN, or the system was unable to retrieve metrics at this time.

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 BackendHealth.
Return type:str