Jump to

• Request
• Response

View a named health check

get

/management/coherence/cluster/health/{healthIdentifier}

Use this endpoint to view a specific named health check in a Coherence cluster. This is an aggregated view of the named health check from all cluster members that it is present on.

Request

Path Parameters

• healthIdentifier: string
  An identifier of a health check.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A successful request that returns the information for the named health check

Body ()

Root Schema : health

Type: object

Show Source

• description(optional): string
  Read Only: true

  The description of the health check
• live(optional): boolean
  Read Only: true

  The live status service represented by the health check
• memberHealthCheck(optional): boolean
  Read Only: true

  A flag indicating whether this health check contributes to the member's overall health
• name(optional): string
  Read Only: true

  The name of the health check
• nodeId(optional): integer(int64)
  Read Only: true

  The ID of member to which the health check belongs
• ready(optional): boolean
  Read Only: true

  The ready status service represented by the health check
• safe(optional): boolean
  Read Only: true

  The safe status service represented by the health check
• started(optional): boolean
  Read Only: true

  The started status service represented by the health check
• type(optional): string
  Read Only: true

  Allowed Values: [ "Health" ]

  The type of the MBean

{
    "type":"object",
    "properties":{
        "nodeId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of member to which the health check belongs",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "description":"The type of the MBean",
            "enum":[
                "Health"
            ],
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of the health check",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "description":"The description of the health check",
            "readOnly":true
        },
        "ready":{
            "type":"boolean",
            "description":"The ready status service represented by the health check",
            "readOnly":true
        },
        "started":{
            "type":"boolean",
            "description":"The started status service represented by the health check",
            "readOnly":true
        },
        "live":{
            "type":"boolean",
            "description":"The live status service represented by the health check",
            "readOnly":true
        },
        "safe":{
            "type":"boolean",
            "description":"The safe status service represented by the health check",
            "readOnly":true
        },
        "memberHealthCheck":{
            "type":"boolean",
            "description":"A flag indicating whether this health check contributes to the member's overall health",
            "readOnly":true
        }
    }
}

404 Response

No health check exists for the specified name

Back to Top