Jump to

• Request
• Response

Get Load Balancer Health

get

/20170115/loadBalancers/{load_balancer_id}/health

Get the health status for the specified load balancer.

Request

Supported Media Types

• application/json

Path Parameters

• loadBalancerId(required): string
  The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to return health status for.

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 : 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.

{
    "type":"object",
    "required":[
        "status",
        "warningStateBackendSetNames",
        "criticalStateBackendSetNames",
        "unknownStateBackendSetNames",
        "totalBackendSetCount"
    ],
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "OK",
                "WARNING",
                "CRITICAL",
                "UNKNOWN"
            ],
            "description":"The overall health status of the load balancer.<li>OK: All backend sets associated with the load balancer return a status of OK.<li>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.<li>CRITICAL: One or more of the backend sets associated with the load balancer return a status of CRITICAL.<li>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."
        },
        "warningStateBackendSetNames":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"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."
        },
        "criticalStateBackendSetNames":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"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."
        },
        "unknownStateBackendSetNames":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"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."
        },
        "totalBackendSetCount":{
            "type":"integer",
            "description":"The total number of backend sets associated with this load balancer. Example: 4 "
        }
    },
    "description":"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.",
    "x-example":"{   \"status\": \"CRITICAL\",   \"warningStateBackendSetNames\": [     \"example_backend_set3\"   ],   \"criticalStateBackendSetNames\": [     \"example_backend_set\"   ],   \"unknownStateBackendSetNames\": [     \"example_backend_set2\"   ],   \"totalBackendSetCount\": 4 } "
}

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

• Array of: string

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

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

• Array of: string

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

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

• Array of: string

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

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