health_checkers
Creates, updates, deletes, gets or lists a health_checkers resource.
Overview​
| Name | health_checkers |
| Type | Resource |
| Id | oci.load_balancer.health_checkers |
Fields​
The following fields are returned by SELECT queries:
- get
The health check policy information is being retrieved.
| Name | Datatype | Description |
|---|---|---|
intervalInMillis | integer (int32) | The interval between health checks, in milliseconds. The default is 10000 (10 seconds). Example: 10000 |
isForcePlainText | boolean | Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL. If "true", health checks will be done using plain text even if the associated backend set is configured to use SSL. If "false", health checks will be done using SSL encryption if the associated backend set is configured to use SSL. If the backend set is not so configured the health checks will be done using plain text. Example: false |
port | integer (int32) | The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the Backend object. Example: 8080 (example: 0) |
protocol | string | The protocol the health check must use; either HTTP or TCP. Example: HTTP |
responseBodyRegex | string | A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$ |
retries | integer (int32) | The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. Defaults to 3. Example: 3 |
returnCode | integer (int32) | The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, you can use common HTTP status codes such as "200". Example: 200 (example: 0) |
timeoutInMillis | integer (int32) | The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. Defaults to 3000 (3 seconds). Example: 3000 |
urlPath | string | The path against which to run the health check. Example: /healthcheck |
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 check policy information for a given load balancer and backend set. |
update | update | loadBalancerId, backendSetName, region, protocol, port, returnCode, retries, timeoutInMillis, intervalInMillis, responseBodyRegex | opc-request-id, opc-retry-token | Updates the health check policy for a given load balancer and 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 associated with the health check policy to be retrieved. Example: example_backend_set |
loadBalancerId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the health check policy to be updated. |
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. |
opc-retry-token | string | A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). |
SELECT examples​
- get
Gets the health check policy information for a given load balancer and backend set.
SELECT
intervalInMillis,
isForcePlainText,
port,
protocol,
responseBodyRegex,
retries,
returnCode,
timeoutInMillis,
urlPath
FROM oci.load_balancer.health_checkers
WHERE loadBalancerId = '{{ loadBalancerId }}' -- required
AND backendSetName = '{{ backendSetName }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;
UPDATE examples​
- update
Updates the health check policy for a given load balancer and backend set.
UPDATE oci.load_balancer.health_checkers
SET
intervalInMillis = {{ intervalInMillis }},
isForcePlainText = {{ isForcePlainText }},
port = {{ port }},
protocol = '{{ protocol }}',
responseBodyRegex = '{{ responseBodyRegex }}',
retries = {{ retries }},
returnCode = {{ returnCode }},
timeoutInMillis = {{ timeoutInMillis }},
urlPath = '{{ urlPath }}'
WHERE
loadBalancerId = '{{ loadBalancerId }}' --required
AND backendSetName = '{{ backendSetName }}' --required
AND region = '{{ region }}' --required
AND protocol = '{{ protocol }}' --required
AND port = '{{ port }}' --required
AND returnCode = '{{ returnCode }}' --required
AND retries = '{{ retries }}' --required
AND timeoutInMillis = '{{ timeoutInMillis }}' --required
AND intervalInMillis = '{{ intervalInMillis }}' --required
AND responseBodyRegex = '{{ responseBodyRegex }}' --required
AND opc-request-id = '{{ opc-request-id}}'
AND opc-retry-token = '{{ opc-retry-token}}';