GetBackendSetHealth

get

/20200501/networkLoadBalancers/{network_load_balancer_id}/backendSets/{backend_set_name}/health

Retrieve the health status for the specified backend set.

Request

Supported Media Types
Path Parameters
Header Parameters
  • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Back to Top

Response

Supported Media Types

200 Response

Retrieved the health status information.
Headers
  • For optimistic concurrency control. See `if-match`.
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : BackendSetHealth
Type: object
The health status details for a backend set. This object does not explicitly enumerate backend servers with a status of OK. However, the backend sets are included in the totalBackendCount sum.
Show Source
  • criticalStateBackendNames
    A list of backend servers that are currently in the CRITICAL health state. The list identifies each backend server by IP address and port. Example: 10.0.0.4:8080
  • Allowed Values: [ "OK", "WARNING", "CRITICAL", "UNKNOWN" ]
    Overall health status of the backend set. OK - All backend servers in the backend set return a status of OK. WARNING - Half or more of the backend servers in a backend set return a status of OK and at least one backend server returns a status of WARNING, CRITICAL, or UNKNOWN. CRITICAL - Fewer than half of the backend servers in a backend set return a status of OK. UNKNOWN - If no probes have yet been sent to the backends, or the system is unable to retrieve metrics from the backends.
  • The total number of backend servers in this backend set. Example: 7
  • unknownStateBackendNames
    A list of backend servers that are currently in the UNKNOWN health state. The list identifies each backend server by IP address and port. Example: 10.0.0.5:8080
  • warningStateBackendNames
    A list of backend servers that are currently in the WARNING health state. The list identifies each backend server by IP address or OCID and port. Example: 10.0.0.3:8080 or ocid1.privateip..unique_ID:8080
Nested Schema : criticalStateBackendNames
Type: array
A list of backend servers that are currently in the CRITICAL health state. The list identifies each backend server by IP address and port. Example: 10.0.0.4:8080
Show Source
Nested Schema : unknownStateBackendNames
Type: array
A list of backend servers that are currently in the UNKNOWN health state. The list identifies each backend server by IP address and port. Example: 10.0.0.5:8080
Show Source
Nested Schema : warningStateBackendNames
Type: array
A list of backend servers that are currently in the WARNING health state. The list identifies each backend server by IP address or OCID and port. Example: 10.0.0.3:8080 or ocid1.privateip..unique_ID:8080
Show Source

400 Response

Bad Request
Headers
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • 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).
  • A human-readable error string.

401 Response

Unauthorized
Headers
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • 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).
  • A human-readable error string.

404 Response

Not Found
Headers
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • 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).
  • A human-readable error string.

409 Response

Conflict
Headers
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • 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).
  • A human-readable error string.

412 Response

Precondition Failed
Headers
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • 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).
  • A human-readable error string.

429 Response

Too Many Requests
Headers
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • 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).
  • A human-readable error string.

500 Response

Internal Server Error
Headers
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • 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).
  • A human-readable error string.

Default Response

Unknown Error
Headers
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • 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).
  • A human-readable error string.
Back to Top