BackendSetHealth¶

class oci.network_load_balancer.models.BackendSetHealth(**kwargs)¶

Bases: object

The health status details for a backend set.

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

Attributes

`STATUS_CRITICAL`	A constant which can be used with the status property of a BackendSetHealth.
`STATUS_OK`	A constant which can be used with the status property of a BackendSetHealth.
`STATUS_UNKNOWN`	A constant which can be used with the status property of a BackendSetHealth.
`STATUS_WARNING`	A constant which can be used with the status property of a BackendSetHealth.
`critical_state_backend_names`	[Required] Gets the critical_state_backend_names of this BackendSetHealth.
`status`	[Required] Gets the status of this BackendSetHealth.
`total_backend_count`	[Required] Gets the total_backend_count of this BackendSetHealth.
`unknown_state_backend_names`	[Required] Gets the unknown_state_backend_names of this BackendSetHealth.
`warning_state_backend_names`	[Required] Gets the warning_state_backend_names of this BackendSetHealth.

Methods

__init__(**kwargs) Initializes a new BackendSetHealth object with values from keyword arguments.

STATUS_CRITICAL = 'CRITICAL'¶: A constant which can be used with the status property of a BackendSetHealth. This constant has a value of “CRITICAL”

STATUS_OK = 'OK'¶: A constant which can be used with the status property of a BackendSetHealth. This constant has a value of “OK”

STATUS_UNKNOWN = 'UNKNOWN'¶: A constant which can be used with the status property of a BackendSetHealth. This constant has a value of “UNKNOWN”

STATUS_WARNING = 'WARNING'¶: A constant which can be used with the status property of a BackendSetHealth. This constant has a value of “WARNING”

__init__(**kwargs)¶

Initializes a new BackendSetHealth 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 BackendSetHealth. 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_names (list[str]) – The value to assign to the warning_state_backend_names property of this BackendSetHealth.
critical_state_backend_names (list[str]) – The value to assign to the critical_state_backend_names property of this BackendSetHealth.
unknown_state_backend_names (list[str]) – The value to assign to the unknown_state_backend_names property of this BackendSetHealth.
total_backend_count (int) – The value to assign to the total_backend_count property of this BackendSetHealth.

critical_state_backend_names¶

[Required] Gets the critical_state_backend_names of this BackendSetHealth. A list of backend servers that are currently in the CRITICAL health state. The list identifies each backend server by IP address and port.

Example: 10.0.0.4:8080

Returns:	The critical_state_backend_names of this BackendSetHealth.
Return type:	list[str]

status¶

[Required] Gets the status of this BackendSetHealth. Overall health status of the backend set.

OK: All backend servers in the backend set return a status of OK.
WARNING: Half or more of the backend servers in a backend set return a status of OK and at least one backend

server returns a status of WARNING, CRITICAL, or UNKNOWN.

CRITICAL: Fewer than half of the backend servers in a backend set return a status of OK.
UNKNOWN: If no probes have yet been sent to the backends, or the system is

unable to retrieve metrics from the backends.

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

total_backend_count¶

[Required] Gets the total_backend_count of this BackendSetHealth. The total number of backend servers in this backend set.

Example: 7

Returns:	The total_backend_count of this BackendSetHealth.
Return type:	int

unknown_state_backend_names¶

[Required] Gets the unknown_state_backend_names of this BackendSetHealth. A list of backend servers that are currently in the UNKNOWN health state. The list identifies each backend server by IP address and port.

Example: 10.0.0.5:8080

Returns:	The unknown_state_backend_names of this BackendSetHealth.
Return type:	list[str]

warning_state_backend_names¶

[Required] Gets the warning_state_backend_names of this BackendSetHealth. A list of backend servers that are currently in the WARNING health state. The list identifies each backend server by IP address or OCID and port.

Example: 10.0.0.3:8080 or ocid1.privateip..oc1.<var><unique_ID></var>:8080

Returns:	The warning_state_backend_names of this BackendSetHealth.
Return type:	list[str]