backend_set_healths
Creates, updates, deletes, gets or lists a backend_set_healths resource.
Overview​
| Name | backend_set_healths |
| Type | Resource |
| Id | oci.load_balancer.backend_set_healths |
Fields​
The following fields are returned by SELECT queries:
- get
The health status information was retrieved.
| Name | Datatype | Description |
|---|---|---|
criticalStateBackendNames | array | 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 |
status | string | 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 set's backend servers 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 set's backend servers return a status of OK. * UNKNOWN: More than half of the backend set's backend servers return a status of UNKNOWN, the system was unable to retrieve metrics, or the backend set does not have a listener attached. (OK, WARNING, CRITICAL, UNKNOWN) |
totalBackendCount | integer | The total number of backend servers in this backend set. Example: 7 |
unknownStateBackendNames | array | 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 |
warningStateBackendNames | array | A list of backend servers that are currently in the WARNING health state. The list identifies each backend server by IP address and port. Example: 10.0.0.3:8080 |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | loadBalancerId, backendSetName, region | opc-request-id | Gets the health status for the specified backend set. |
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 |
|---|---|---|
backendSetName | string | The name of the backend set to retrieve the health status for. Example: example_backend_set |
loadBalancerId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set health status to be retrieved. |
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) |
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. |
SELECT examples​
- get
Gets the health status for the specified backend set.
SELECT
criticalStateBackendNames,
status,
totalBackendCount,
unknownStateBackendNames,
warningStateBackendNames
FROM oci.load_balancer.backend_set_healths
WHERE loadBalancerId = '{{ loadBalancerId }}' -- required
AND backendSetName = '{{ backendSetName }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;