LoadBalancerHealth
get
/20170115/loadBalancers/{load_balancer_id}/health
Gets the health status for the specified load balancer.
Request
Supported Media Types
- application/json
Path Parameters
-
loadBalancerId(required): string
The OCID of the load balancer to return health status for.
Header Parameters
-
opc-request-id: string
The unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.Default Value:
Response
Supported Media Types
- application/json
200 Response
The health status information was retrieved.
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 : LoadBalancerHealth
Type:
object
The health status details for the specified load balancer. This object does not explicitly enumerate backend sets with a status of OK. However, they are included in the totalBackendSetCount sum.
Show Source
-
criticalStateBackendSetNames(required):
array criticalStateBackendSetNames
A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the user-friendly name you assigned when you created it.
-
status(required):
string
Allowed Values:
[ "OK", "WARNING", "CRITICAL", "UNKNOWN" ]
The overall health status of the load balancer.- OK: All backend sets associated with the load balancer return a status of OK.
- WARNING: At least one of the backend sets associated with the load balancer returns a status of WARNING, no backend sets return a status of CRITICAL, and the load balancer life cycle state is ACTIVE.
- CRITICAL: One or more of the backend sets associated with the load balancer return a status of CRITICAL.
- UNKNOWN: Any one of the following conditions is true: The load balancer life cycle state is not ACTIVE; no backend sets are defined for the load balancer; more than half of the backend sets associated with the load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the load balancer life cycle state is ACTIVE; the system could not retrieve metrics for any reason.
-
totalBackendSetCount(required):
integer
The total number of backend sets associated with this load balancer. Example: 4
-
unknownStateBackendSetNames(required):
array unknownStateBackendSetNames
A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the user-friendly name you assigned when you created it.
-
warningStateBackendSetNames(required):
array warningStateBackendSetNames
A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the user-friendly name you assigned when you created it.
Nested Schema : criticalStateBackendSetNames
Type:
array
A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the user-friendly name you assigned when you created it.
Show Source
Nested Schema : unknownStateBackendSetNames
Type:
array
A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the user-friendly name you assigned when you created it.
Show Source
Nested Schema : warningStateBackendSetNames
Type:
array
A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the user-friendly name you assigned when you created it.
Show Source
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
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
An error has occurred.
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