Jump to

• Request
• Response

View Cluster Information

get

/management/coherence/cluster

Use this endpoint to verify which cluster you are managing and to check whether the cluster is operational. You can also use this endpoint to get a list of cluster members and their associated IDs. Cluster information is often used as parameters when performing other resource operations.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A successful request that returns information about a Coherence cluster

Body ()

Root Schema : cluster

Type: object

Show Source

• clusterName(optional): string
  Read Only: true

  The name of the cluster.
• clusterSize(optional): integer(int32)
  Read Only: true

  The total number of cluster nodes.
• licenseMode(optional): string
  Read Only: true

  The license mode that this cluster is using. Possible values are Evaluation, Development or Production.
• localMemberId(optional): integer(int32)
  Read Only: true

  The member id for the cluster member that is co-located with the reporting MBeanServer; -1 if the cluster service is not running.
• location(optional): string
  Read Only: true

  The location of the MBean server
• memberIds(optional): array memberIds
  Read Only: true

  An array of all existing cluster member ids.
• members(optional): array members
  Read Only: true

  An array of all existing cluster members.
• membersDeparted(optional): array membersDeparted
  Read Only: true

  An array of strings containing the Member information for recently departed cluster members. Members will be removed from this array when the member id is recycled. This information is since the node has joined the cluster and is reset when the MBeanServer node leaves and rejoins the cluster. The MembersDepartureCount is the total count of departed members and not the size of this array.
• membersDepartureCount(optional): integer(int64)
  Read Only: true

  The number of times this node has observed another node`s departure from the cluster since this management node has joined the cluster or statistics have been reset.
• oldestMemberId(optional): integer(int32)
  Read Only: true

  The senior cluster member id; -1 if the cluster service is not running.
• refreshTime(optional): string(date-time)
  Read Only: true

  The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
• running(optional): boolean
  Read Only: true

  Specifies whether or not the cluster is running.
• type(optional): string
  Read Only: true

  Allowed Values: [ "Cluster" ]

  The type of the MBean
• version(optional): string
  Read Only: true

  The Coherence version.

{
    "type":"object",
    "properties":{
        "location":{
            "type":"string",
            "description":"The location of the MBean server",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "description":"The type of the MBean",
            "enum":[
                "Cluster"
            ],
            "readOnly":true
        },
        "refreshTime":{
            "type":"string",
            "format":"date-time",
            "description":"The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.",
            "readOnly":true
        },
        "licenseMode":{
            "type":"string",
            "description":"The license mode that this cluster is using. Possible values are Evaluation, Development or Production.",
            "readOnly":true
        },
        "clusterSize":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of cluster nodes.",
            "readOnly":true
        },
        "localMemberId":{
            "type":"integer",
            "format":"int32",
            "description":"The member id for the cluster member that is co-located with the reporting MBeanServer; -1 if the cluster service is not running.",
            "readOnly":true
        },
        "version":{
            "type":"string",
            "description":"The Coherence version.",
            "readOnly":true
        },
        "running":{
            "type":"boolean",
            "description":"Specifies whether or not the cluster is running.",
            "readOnly":true
        },
        "clusterName":{
            "type":"string",
            "description":"The name of the cluster.",
            "readOnly":true
        },
        "membersDeparted":{
            "type":"array",
            "description":"An array of strings containing the Member information for recently departed cluster members.   Members will be removed from this array when the member id is recycled. This information is since the node has joined the cluster and is reset when the MBeanServer node leaves and rejoins the cluster. The MembersDepartureCount is the total count of departed members and not the size of this array.",
            "items":{
                "type":"string"
            },
            "readOnly":true
        },
        "memberIds":{
            "type":"array",
            "description":"An array of all existing cluster member ids.",
            "items":{
                "type":"integer"
            },
            "readOnly":true
        },
        "membersDepartureCount":{
            "type":"integer",
            "format":"int64",
            "description":"The number of times this node has observed another node`s departure from the cluster since this management node has joined the cluster or statistics have been reset.",
            "readOnly":true
        },
        "members":{
            "type":"array",
            "description":"An array of all existing cluster members.",
            "items":{
                "type":"string"
            },
            "readOnly":true
        },
        "oldestMemberId":{
            "type":"integer",
            "format":"int32",
            "description":"The senior cluster member id; -1 if the cluster service is not running.",
            "readOnly":true
        }
    }
}

Nested Schema : memberIds

Type: array

Read Only: true

An array of all existing cluster member ids.

Show Source

• Array of: integer

{
    "type":"array",
    "description":"An array of all existing cluster member ids.",
    "items":{
        "type":"integer"
    },
    "readOnly":true
}

Nested Schema : members

Type: array

Read Only: true

An array of all existing cluster members.

Show Source

• Array of: string

{
    "type":"array",
    "description":"An array of all existing cluster members.",
    "items":{
        "type":"string"
    },
    "readOnly":true
}

Nested Schema : membersDeparted

Type: array

Read Only: true

An array of strings containing the Member information for recently departed cluster members. Members will be removed from this array when the member id is recycled. This information is since the node has joined the cluster and is reset when the MBeanServer node leaves and rejoins the cluster. The MembersDepartureCount is the total count of departed members and not the size of this array.

Show Source

• Array of: string

{
    "type":"array",
    "description":"An array of strings containing the Member information for recently departed cluster members.   Members will be removed from this array when the member id is recycled. This information is since the node has joined the cluster and is reset when the MBeanServer node leaves and rejoins the cluster. The MembersDepartureCount is the total count of departed members and not the size of this array.",
    "items":{
        "type":"string"
    },
    "readOnly":true
}

Back to Top