REST API for Oracle Private Cloud Appliance Compute Enclave

GetBackendHealth

get

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

Retrieve 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..oc1.<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. If you must contact Oracle about a particular request, then provide the request identifier.

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.

{
    "type":"object",
    "required":[
        "status",
        "healthCheckResults"
    ],
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "OK",
                "WARNING",
                "CRITICAL",
                "UNKNOWN"
            ],
            "description":"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."
        },
        "healthCheckResults":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/HealthCheckResult"
            },
            "description":"A list of the most recent health check results returned for the specified backend server."
        }
    },
    "description":"The health status of the specified backend server.",
    "x-example":"{   \"status\": \"OK\",   \"healthCheckResults\": [     {       \"timestamp\": \"2020-05-09T21:58:11.417Z\",       \"healthCheckStatus\": \"OK\"     }   ] } "
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/HealthCheckResult"
    },
    "description":"A list of the most recent health check results returned for the specified backend server."
}

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

{
    "type":"object",
    "required":[
        "timestamp",
        "healthCheckStatus"
    ],
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the data was retrieved, in the format defined by RFC3339. Example: 2020-05-01T18:28:11+00:00 "
        },
        "healthCheckStatus":{
            "type":"string",
            "enum":[
                "OK",
                "INVALID_STATUS_CODE",
                "TIMED_OUT",
                "HEALTH_PAYLOAD_MISMATCH",
                "CONNECT_FAILED",
                "UNKNOWN"
            ],
            "description":"The result of the most recent health check."
        }
    },
    "description":"Information about a single backend server health check result reported by a network load balancer.",
    "x-example":"{   \"timestamp\": \"2020-05-01T21:58:11.417Z\",   \"healthCheckStatus\": \"OK\" } "
}

400 Response

Bad Request

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

409 Response

Conflict

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

412 Response

Precondition Failed

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

429 Response

Too Many Requests

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

Unknown Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}