GetBackendHealth
get
/20200501/networkLoadBalancers/{network_load_balancer_id}/backendSets/{backend_set_name}/backends/{backend_name}/health
Retrieves the current health status of the specified backend server.
Request
Supported Media Types
- application/json
Path Parameters
-
backendName(required): string
The name of the backend server to retrieve health status for. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as
: . If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as : . Example: 10.0.0.3:8080 or ocid1.privateip..unique_ID:8080 -
backendSetName(required): string
The name of the backend set associated with the backend server for which to retrieve the health status. Example: example_backend_set
-
networkLoadBalancerId(required): string
The OCID of the network load balancer to update.Default Value:
Header Parameters
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Response
Supported Media Types
- application/json
200 Response
Retrieved the health status information.
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
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. Provide this request OCID if you need to contact Oracle about this request.
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..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
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..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
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..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
409 Response
Conflict
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
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..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
412 Response
Precondition Failed
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
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..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
429 Response
Too Many Requests
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
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..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
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..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
Default Response
Unknown Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
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..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload