REST API Reference for Managing Oracle Coherence

View the List of health checks for all members

get

/management/coherence/cluster/health/members

Use this endpoint to list the health checks in all Coherence cluster members.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

A successful request that returns the health checks for all members in a Coherence cluster

Root Schema : schema

Type: object

Show Source

items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/health"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object health

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

Nested Schema : health

Type: object

Show Source

description: string

Read Only: true

The description of the health check
live: boolean

Read Only: true

The live status service represented by the health check
memberHealthCheck: boolean

Read Only: true

A flag indicating whether this health check contributes to the member's overall health
name: string

Read Only: true

The name of the health check
nodeId: integer(int64)

Read Only: true

The ID of member to which the health check belongs
ready: boolean

Read Only: true

The ready status service represented by the health check
safe: boolean

Read Only: true

The safe status service represented by the health check
started: boolean

Read Only: true

The started status service represented by the health check
type: 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
        }
    }
}