backend_healths
Creates, updates, deletes, gets or lists a backend_healths resource.
Overview​
| Name | backend_healths |
| Type | Resource |
| Id | oci.load_balancer.backend_healths |
Fields​
The following fields are returned by SELECT queries:
- get
The health status information was retrieved.
| Name | Datatype | Description |
|---|---|---|
healthCheckResults | array | A list of the most recent health check results returned for the specified backend server. |
status | string | 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. (OK, WARNING, CRITICAL, UNKNOWN) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | loadBalancerId, backendSetName, backendName, region | opc-request-id | Gets the current health status of the specified backend server. |
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 |
|---|---|---|
backendName | string | The IP address and port of the backend server to retrieve the health status for. Example: 10.0.0.3:8080 |
backendSetName | string | The name of the backend set associated with the backend server 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 server 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 current health status of the specified backend server.
SELECT
healthCheckResults,
status
FROM oci.load_balancer.backend_healths
WHERE loadBalancerId = '{{ loadBalancerId }}' -- required
AND backendSetName = '{{ backendSetName }}' -- required
AND backendName = '{{ backendName }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;