load_balancer_healths

Creates, updates, deletes, gets or lists a load_balancer_healths resource.

Overview

Name	load_balancer_healths
Type	Resource
Id	oci.load_balancer.load_balancer_healths

Fields

The following fields are returned by SELECT queries:

get

The health status information was retrieved.

Name	Datatype	Description
criticalStateBackendSetNames	array	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
status	string	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. (OK, WARNING, CRITICAL, UNKNOWN)
totalBackendSetCount	integer	The total number of backend sets associated with this load balancer. Example: 4
unknownStateBackendSetNames	array	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
warningStateBackendSetNames	array	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

list

A health status summary for the specified load balancer.

Name	Datatype	Description
loadBalancerId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer the health status is associated with.
status	string	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. (OK, WARNING, CRITICAL, UNKNOWN)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	loadBalancerId, region	opc-request-id	Gets the health status for the specified load balancer.
list	select	compartmentId, region	opc-request-id, limit, page	Lists the summary health statuses for all load balancers in the specified compartment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
compartmentId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancers to return health status information for.
loadBalancerId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to return health status for.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
limit	integer (int64)	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50
opc-request-id	string	The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
page	string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 3

SELECT examples

get

Gets the health status for the specified load balancer.

SELECT
criticalStateBackendSetNames,
status,
totalBackendSetCount,
unknownStateBackendSetNames,
warningStateBackendSetNames
FROM oci.load_balancer.load_balancer_healths
WHERE loadBalancerId = '{{ loadBalancerId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Lists the summary health statuses for all load balancers in the specified compartment.

SELECT
loadBalancerId,
status
FROM oci.load_balancer.load_balancer_healths
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
;