Get Backend Server Health
get
/20170115/loadBalancers/{load_balancer_id}/backendSets/{backend_set_name}/backends/{backend_name}/health
Get the current health status of the specified backend server.
Request
Supported Media Types
- application/json
Path Parameters
-
backendName(required): string
The IP address and port of the backend server to retrieve the health status for. Example: `10.0.0.3:8080`
-
backendSetName(required): string
The name of the backend set associated with the backend server to retrieve the health status for. Example: `example_backend_set`
-
loadBalancerId(required): string
The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend server health status to be retrieved.
Header Parameters
-
if-match: string
For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the ETag for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer. For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets. The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value. Example: `example-etag`Default Value:
-
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.Default Value:
Response
Supported Media Types
- application/json
200 Response
The health status information was retrieved.
Headers
-
eTag: string
Reflects the current version of the load balancer and the resources it contains. The value only changes when the load balancer or an associated resource is created, updated, or delete For optimistic concurrency control. See `if-match`.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : BackendHealth
Type:
object
The health status of the specified backend server.
Show Source
-
healthCheckResults(required):
array healthCheckResults
A list of the most recent health check results returned for the specified backend server.
-
status(required):
string
Allowed Values:
[ "OK", "WARNING", "CRITICAL", "UNKNOWN" ]
The general health status of the specified backend server. OK - All health check probes return OK. WARNING - At least one of the health check probes does not return OK. CRITICAL - None of the health check probes return OK. UNKNOWN - One of the health checks probes return UNKNOWN, or the system is unable to retrieve metrics at this time.
Nested Schema : healthCheckResults
Type:
array
A list of the most recent health check results returned for the specified backend server.
Show Source
-
Array of:
object HealthCheckResult
Information about a single backend server health check result reported by a network load balancer.
Nested Schema : HealthCheckResult
Type:
object
Information about a single backend server health check result reported by a network load balancer.
Show Source
-
healthCheckStatus(required):
string
Allowed Values:
[ "OK", "INVALID_STATUS_CODE", "TIMED_OUT", "HEALTH_PAYLOAD_MISMATCH", "CONNECT_FAILED", "UNKNOWN" ]
The result of the most recent health check. -
timestamp(required):
string(date-time)
The date and time the data was retrieved, in the format defined by RFC3339. Example: 2020-05-01T18:28:11+00:00
400 Response
Bad Request
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
409 Response
Conflict
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
412 Response
Precondition Failed
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
429 Response
Too Many Requests
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
Default Response
An error has occurred.
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.