Jump to

• Request
• Response

ListLoadBalancerHealths

get

/20170115/loadBalancerHealths

Lists the summary health statuses for all load balancers in the specified compartment.

Request

Supported Media Types

• application/json

Query Parameters

• compartmentId(required): string
  The OCID of the compartment containing the load balancers to return health status information for.
• limit: integer(int64)
  For list pagination. The maximum number of results per page, or items to return in a paginated List call.

  Default Value: 10
• page: string
  For list pagination. The value of the opc-next-page response header from the previous List call. Example: 3

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:

Back to Top

Response

Supported Media Types

• application/json

200 Response

The health status information was retrieved.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object LoadBalancerHealthSummary
  A health status summary for the specified load balancer.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LoadBalancerHealthSummary"
    }
}

Nested Schema : LoadBalancerHealthSummary

Type: object

A health status summary for the specified load balancer.

Show Source

• loadBalancerId(required): string
  The OCID of the load balancer the health status is associated with.
• 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 - If 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.

{
    "type":"object",
    "required":[
        "loadBalancerId",
        "status"
    ],
    "properties":{
        "loadBalancerId":{
            "type":"string",
            "description":"The OCID of the load balancer the health status is associated with."
        },
        "status":{
            "type":"string",
            "enum":[
                "OK",
                "WARNING",
                "CRITICAL",
                "UNKNOWN"
            ],
            "description":"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 - If 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."
        }
    },
    "description":"A health status summary for the specified load balancer.",
    "x-example":"{   \"loadBalancerId\": \"ocid1.loadbalancer.<var>unique_ID</var>\",   \"status\": \"OK\" } "
}

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.

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top