Jump to

• Request
• Response

Get Backend Set Health

get

/20170115/loadBalancers/{load_balancer_id}/backendSets/{backend_set_name}/health

Get the health status for the specified backend set.

Request

Supported Media Types

• application/json

Path Parameters

• backendSetName(required): string
  The name of the backend set 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 set 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:

Back to Top

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.

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(required): array 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
• status(required): string
  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.
• totalBackendCount(required): integer
  The total number of backend servers in this backend set. Example: 7
• unknownStateBackendNames(required): array 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(required): array 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

{
    "type":"object",
    "required":[
        "status",
        "warningStateBackendNames",
        "criticalStateBackendNames",
        "unknownStateBackendNames",
        "totalBackendCount"
    ],
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "OK",
                "WARNING",
                "CRITICAL",
                "UNKNOWN"
            ],
            "description":"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."
        },
        "warningStateBackendNames":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"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..<var>unique_ID</var>:8080 "
        },
        "criticalStateBackendNames":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"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 "
        },
        "unknownStateBackendNames":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"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 "
        },
        "totalBackendCount":{
            "type":"integer",
            "description":"The total number of backend servers in this backend set. Example: 7 "
        }
    },
    "description":"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.",
    "x-example":"{   \"status\": \"WARNING\",   \"warningStateBackendNames\": [     \"10.0.0.3:8080\"   ],   \"criticalStateBackendNames\": [     \"10.0.0.4:8080\"   ],   \"unknownStateBackendNames\": [     \"ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>\"   ],   \"totalBackendCount\": 7 } "
}

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

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"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 "
}

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

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"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 "
}

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

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"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..<var>unique_ID</var>:8080 "
}

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.

Body ()

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 need to contact Oracle about a particular request, please provide the request ID.

Body ()

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 need to contact Oracle about a particular request, please provide the request ID.

Body ()

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 need to contact Oracle about a particular request, please provide the request ID.

Body ()

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 need to contact Oracle about a particular request, please provide the request ID.

Body ()

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 need to contact Oracle about a particular request, please provide the request ID.

Body ()

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 need to contact Oracle about a particular request, please provide the request ID.

Body ()

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

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.

Body ()

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"
}

Back to Top