Jump to

• Request
• Response

View Cluster Members

get

/management/coherence/cluster/members

Use this endpoint to list all the members of a Coherence cluster.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A successful request that lists Coherence cluster members

Body ()

Root Schema : schema

Type: object

Show Source

• items(optional): array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object member

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

Nested Schema : member

Type: object

Show Source

• bufferPublishSize(optional): integer(int32)
  The buffer size of the unicast datagram socket used by the Publisher, measured in the number of packets. Changing this value at runtime is an inherently unsafe operation that will pause all network communications and may result in the termination of all cluster services.
• bufferReceiveSize(optional): integer(int32)
  The buffer size of the unicast datagram socket used by the Receiver, measured in the number of packets. Changing this value at runtime is an inherently unsafe operation that will pause all network communications and may result in the termination of all cluster services.
• cpuCount(optional): integer(int32)
  Read Only: true

  Number of CPU cores for the machine this Member is running on.
• flowControlEnabled(optional): boolean
  Read Only: true

  Indicates whether or not FlowControl is enabled.
• guardRecoverCount(optional): integer(int32)
  Read Only: true

  The number of recovery attempts executed for all guardables on this node since the node statistics were last reset.
• guardTerminateCount(optional): integer(int32)
  Read Only: true

  The number of termination attempts executed for all guardables on this node since the node statistics were last reset.
• id(optional): integer(int32)
  Read Only: true

  The short Member id that uniquely identifies the Member at this point in time and does not change for the life of this Member.
• location(optional): string
  Read Only: true

  The location of the MBean server
• loggingDestination(optional): string
  Read Only: true

  The output device used by the logging system. Valid values are stdout, stderr, jdk, log4j2, or a file name.
• loggingFormat(optional): string
  Specifies how messages will be formatted before being passed to the log destination
• loggingLevel(optional): integer(int32)
  Specifies which logged messages will be output to the log destination. Valid values are non-negative integers or -1 to disable all logger output.
• loggingLimit(optional): integer(int32)
  The maximum number of characters that the logger daemon will process from the message queue before discarding all remaining messages in the queue. Valid values are integers in the range [0...]. Zero implies no limit.
• machineId(optional): integer(int32)
  Read Only: true

  The Member`s machine Id.
• machineName(optional): string
  Read Only: true

  A configured name that should be the same for all Members that are on the same physical machine, and different for Members that are on different physical machines.
• member(optional): string
  Name of the cluster member
• memberName(optional): string
  Read Only: true

  A configured name that must be unique for every Member.
• memoryAvailableMB(optional): integer(int32)
  Read Only: true

  The total amount of memory in the JVM available for new objects in MB.
• memoryMaxMB(optional): integer(int32)
  Read Only: true

  The maximum amount of memory that the JVM will attempt to use in MB.
• multicastAddress(optional): string
  Read Only: true

  The IP address of the Member`s MulticastSocket for group communication.
• multicastEnabled(optional): boolean
  Read Only: true

  Specifies whether or not this Member uses multicast for group communication. If false, this Member will use the WellKnownAddresses to join the cluster and point-to-point unicast to communicate with other Members of the cluster.
• multicastPort(optional): integer(int32)
  Read Only: true

  The port of the Member`s MulticastSocket for group communication.
• multicastThreshold(optional): integer(int32)
  The percentage (0 to 100) of the servers in the cluster that a packet will be sent to, above which the packet will be multicasted and below which it will be unicasted.
• multicastTTL(optional): integer(int32)
  Read Only: true

  The time-to-live for multicast packets sent out on this Member`s MulticastSocket.
• nackEnabled(optional): boolean
  Read Only: true

  Indicates whether or not the early packet loss detection protocol is enabled.
• nackSent(optional): integer(int64)
  Read Only: true

  The total number of NACK packets sent since the node statistics were last reset.
• nodeId(optional): integer(int64)
  Read Only: true

  The ID of member to which the MBean belongs
• packetDeliveryEfficiency(optional): number(float)
  Read Only: true

  The efficiency of packet loss detection and retransmission. A low efficiency is an indication that there is a high rate of unnecessary packet retransmissions.
• packetsBundled(optional): integer(int64)
  Read Only: true

  The total number of packets which were bundled prior to transmission. The total number of network transmissions is equal to (PacketsSent - PacketsBundled).
• packetsReceived(optional): integer(int64)
  Read Only: true

  The number of packets received since the node statistics were last reset.
• packetsRepeated(optional): integer(int64)
  Read Only: true

  The number of duplicate packets received since the node statistics were last reset.
• packetsResent(optional): integer(int64)
  Read Only: true

  The number of packets resent since the node statistics were last reset. A packet is resent when there is no ACK received within a timeout period.
• packetsResentEarly(optional): integer(int64)
  Read Only: true

  The total number of packets resent ahead of schedule. A packet is resent ahead of schedule when there is a NACK indicating that the packet has not been received.
• packetsResentExcess(optional): integer(int64)
  Read Only: true

  The total number of packet retransmissions which were later proven unnecessary.
• packetsSent(optional): integer(int64)
  Read Only: true

  The number of packets sent since the node statistics were last reset.
• priority(optional): integer(int32)
  Read Only: true

  The priority or "weight" of the Member; used to determine tie-breakers.
• processName(optional): string
  Read Only: true

  A configured name that should be the same for Members that are in the same process (JVM), and different for Members that are in different processes. If not explicitly provided, for processes running with JRE 1.5 or higher the name will be calculated internally as the Name attribute of the system RuntimeMXBean, which normally represents the process identifier (PID).
• productEdition(optional): string
  Read Only: true

  The product edition this Member is running. Possible values are Standard Edition (SE), Enterprise Edition (EE), Grid Edition (GE).
• publisherPacketUtilization(optional): number(float)
  Read Only: true

  The publisher packet utilization for this cluster node since the node socket was last reopened. This value is a ratio of the number of bytes sent to the number that would have been sent had all packets been full. A low utilization indicates that data is not being sent in large enough chunks to make efficient use of the network.
• publisherSuccessRate(optional): number(float)
  Read Only: true

  The publisher success rate for this cluster node since the node statistics were last reset. Publisher success rate is a ratio of the number of packets successfully delivered in a first attempt to the total number of sent packets. A failure count is incremented when there is no ACK received within a timeout period. It could be caused by either very high network latency or a high packet drop rate.
• quorumStatus(optional): string
  Read Only: true

  The current state of the cluster quorum.
• rackName(optional): string
  Read Only: true

  A configured name that should be the same for Members that are on the same physical "rack" (or frame or cage), and different for Members that are on different physical "racks".
• receiverPacketUtilization(optional): number(float)
  Read Only: true

  The receiver packet utilization for this cluster node since the socket was last reopened. This value is a ratio of the number of bytes received to the number that would have been received had all packets been full. A low utilization indicates that data is not being sent in large enough chunks to make efficient use of the network.
• receiverSuccessRate(optional): number(float)
  Read Only: true

  The receiver success rate for this cluster node since the node statistics were last reset. Receiver success rate is a ratio of the number of packets successfully acknowledged in a first attempt to the total number of received packets. A failure count is incremented when a re-delivery of previously received packet is detected. It could be caused by either very high inbound network latency or lost ACK packets.
• 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.
• resendDelay(optional): integer(int32)
  The minimum number of milliseconds that a packet will remain queued in the Publisher`s re-send queue before it is resent to the recipient(s) if the packet has not been acknowledged. Setting this value too low can overflow the network with unnecessary repetitions. Setting the value too high can increase the overall latency by delaying the re-sends of dropped packets. Additionally, change of this value may need to be accompanied by a change in SendAckDelay value.
• roleName(optional): string
  Read Only: true

  A configured name that can be used to indicate the role of a Member to the application. While managed by Coherence, this property is used only by the application.
• sendAckDelay(optional): integer(int32)
  The minimum number of milliseconds between the queueing of an Ack packet and the sending of the same. This value should be not more then a half of the ResendDelay value.
• sendQueueSize(optional): integer(int32)
  Read Only: true

  The number of packets currently scheduled for delivery. This number includes both packets that are to be sent immediately and packets that have already been sent and awaiting for acknowledgment. Packets that do not receive an acknowledgment within ResendDelay interval will be automatically resent.
• siteName(optional): string
  Read Only: true

  A configured name that should be the same for Members that are on the same physical site (e.g. data center), and different for Members that are on different physical sites.
• socketCount(optional): integer(int32)
  Read Only: true

  Number of CPU sockets for the machine this Member is running on.
• statistics(optional): string
  Read Only: true

  Statistics for this cluster node in a human readable format.
• tcpRingFailures(optional): integer(int64)
  Read Only: true

  The number of recovered TcpRing disconnects since the node statistics were last reset. A recoverable disconnect is an abnormal event that is registered when the TcpRing peer drops the TCP connection, but recovers after no more then maximum configured number of attempts.This value will be -1 if the TcpRing is disabled.
• timestamp(optional): string(date-time)
  Read Only: true

  The date/time value (in cluster time) that this Member joined the cluster.
• tracingSamplingRatio(optional): number(float)
  The ratio of spans to trace when tracing is enabled.
• trafficJamCount(optional): integer(int32)
  The maximum total number of packets in the send and resend queues that forces the publisher to pause client threads. Zero means no limit.
• trafficJamDelay(optional): integer(int32)
  The number of milliseconds to pause client threads when a traffic jam condition has been reached. Anything less than one (e.g. zero) is treated as one millisecond.
• type(optional): string
  Read Only: true

  Allowed Values: [ "Node" ]

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

  The unique identifier of the Member which is calculated based on its Timestamp, Address, Port and MachineId. This identifier is unique throughout the life of the cluster.
• unicastAddress(optional): string
  Read Only: true

  The IP address of the Member`s DatagramSocket for point-to-point communication.
• unicastPort(optional): integer(int32)
  Read Only: true

  The port of the Member`s DatagramSocket for point-to-point communication.
• weakestChannel(optional): integer(int32)
  Read Only: true

  The id of the cluster node to which this node is having the most difficulty communicating, or -1 if none is found. A channel is considered to be weak if either the point-to-point publisher or receiver success rates are below 1.0.
• wellKnownAddresses(optional): array wellKnownAddresses
  Read Only: true

  An array of well-known socket addresses that this Member uses to join the cluster.

{
    "type":"object",
    "properties":{
        "nodeId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of member to which the MBean belongs",
            "readOnly":true
        },
        "location":{
            "type":"string",
            "description":"The location of the MBean server",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "description":"The type of the MBean",
            "enum":[
                "Node"
            ],
            "readOnly":true
        },
        "member":{
            "type":"string",
            "description":"Name of the cluster member"
        },
        "processName":{
            "type":"string",
            "description":"A configured name that should be the same for Members that are in the same process (JVM), and different for Members that are in different processes. If not explicitly provided, for processes running with JRE 1.5 or higher the name will be calculated internally as the Name attribute of the system RuntimeMXBean, which normally represents the process identifier (PID).",
            "readOnly":true
        },
        "socketCount":{
            "type":"integer",
            "format":"int32",
            "description":"Number of CPU sockets for the machine this Member is running on.",
            "readOnly":true
        },
        "siteName":{
            "type":"string",
            "description":"A configured name that should be the same for Members that are on the same physical site (e.g. data center), and different for Members that are on different physical sites.",
            "readOnly":true
        },
        "publisherSuccessRate":{
            "type":"number",
            "format":"float",
            "description":"The publisher success rate for this cluster node since the node statistics were last reset. Publisher success rate is a ratio of the number of packets successfully delivered in a first attempt to the total number of sent packets. A failure count is incremented when there is no ACK received within a timeout period. It could be caused by either very high network latency or a high packet drop rate.",
            "readOnly":true
        },
        "trafficJamCount":{
            "type":"integer",
            "format":"int32",
            "description":"The maximum total number of packets in the send and resend queues that forces the publisher to pause client threads. Zero means no limit.",
            "readOnly":false
        },
        "multicastEnabled":{
            "type":"boolean",
            "description":"Specifies whether or not this Member uses multicast for group communication. If false, this Member will use the WellKnownAddresses to join the cluster and point-to-point unicast to communicate with other Members of the 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
        },
        "bufferReceiveSize":{
            "type":"integer",
            "format":"int32",
            "description":"The buffer size of the unicast datagram socket used by the Receiver, measured in the number of packets. Changing this value at runtime is an inherently unsafe operation that will pause all network communications and may result in the termination of all cluster services.",
            "readOnly":false
        },
        "loggingDestination":{
            "type":"string",
            "description":"The output device used by the logging system. Valid values are stdout, stderr, jdk, log4j2, or a file name.",
            "readOnly":true
        },
        "multicastTTL":{
            "type":"integer",
            "format":"int32",
            "description":"The time-to-live for multicast packets sent out on this Member`s MulticastSocket.",
            "readOnly":true
        },
        "sendAckDelay":{
            "type":"integer",
            "format":"int32",
            "description":"The minimum number of milliseconds between the queueing of an Ack packet and the sending of the same. This value should be not more then a half of the ResendDelay value.",
            "readOnly":false
        },
        "unicastPort":{
            "type":"integer",
            "format":"int32",
            "description":"The port of the Member`s DatagramSocket for point-to-point communication.",
            "readOnly":true
        },
        "nackEnabled":{
            "type":"boolean",
            "description":"Indicates whether or not the early packet loss detection protocol is enabled.",
            "readOnly":true
        },
        "loggingFormat":{
            "type":"string",
            "description":"Specifies how messages will be formatted before being passed to the log destination",
            "readOnly":false
        },
        "packetsReceived":{
            "type":"integer",
            "format":"int64",
            "description":"The number of packets received since the node statistics were last reset.",
            "readOnly":true
        },
        "packetsSent":{
            "type":"integer",
            "format":"int64",
            "description":"The number of packets sent since the node statistics were last reset.",
            "readOnly":true
        },
        "sendQueueSize":{
            "type":"integer",
            "format":"int32",
            "description":"The number of packets currently scheduled for delivery. This number includes both packets that are to be sent immediately and packets that have already been sent and awaiting for acknowledgment. Packets that do not receive an acknowledgment within ResendDelay interval will be automatically resent.",
            "readOnly":true
        },
        "priority":{
            "type":"integer",
            "format":"int32",
            "description":"The priority or \"weight\" of the Member; used to determine tie-breakers.",
            "readOnly":true
        },
        "resendDelay":{
            "type":"integer",
            "format":"int32",
            "description":"The minimum number of milliseconds that a packet will remain queued in the Publisher`s re-send queue before it is resent to the recipient(s) if the packet has not been acknowledged. Setting this value too low can overflow the network with unnecessary repetitions. Setting the value too high can increase the overall latency by delaying the re-sends of dropped packets. Additionally, change of this value may need to be accompanied by a change in SendAckDelay value.",
            "readOnly":false
        },
        "productEdition":{
            "type":"string",
            "description":"The product edition this Member is running. Possible values  are Standard Edition (SE), Enterprise Edition (EE), Grid Edition (GE).",
            "readOnly":true
        },
        "memoryMaxMB":{
            "type":"integer",
            "format":"int32",
            "description":"The maximum amount of memory that the JVM will attempt to use in MB.",
            "readOnly":true
        },
        "trafficJamDelay":{
            "type":"integer",
            "format":"int32",
            "description":"The number of milliseconds to pause client threads when a traffic jam condition has been reached. Anything less than one (e.g. zero) is treated as one millisecond.",
            "readOnly":false
        },
        "guardRecoverCount":{
            "type":"integer",
            "format":"int32",
            "description":"The number of recovery attempts executed for all guardables on this node since the node statistics were last reset.",
            "readOnly":true
        },
        "multicastThreshold":{
            "type":"integer",
            "format":"int32",
            "description":"The percentage (0 to 100) of the servers in the cluster that a packet will be sent to, above which the packet will be multicasted and below which it will be unicasted.",
            "readOnly":false
        },
        "UID":{
            "type":"string",
            "description":"The unique identifier of the Member which is calculated based on its Timestamp, Address, Port and MachineId. This identifier is unique throughout the life of the cluster.",
            "readOnly":true
        },
        "roleName":{
            "type":"string",
            "description":"A configured name that can be used to indicate the role of a Member to the application. While managed by Coherence, this property is used only by the application.",
            "readOnly":true
        },
        "multicastAddress":{
            "type":"string",
            "description":"The IP address of the Member`s MulticastSocket for group communication.",
            "readOnly":true
        },
        "machineName":{
            "type":"string",
            "description":"A configured name that should be the same for all Members that are on the same physical machine, and different for Members that are on different physical machines.",
            "readOnly":true
        },
        "id":{
            "type":"integer",
            "format":"int32",
            "description":"The short Member id that uniquely identifies the Member at this point in time and does not change for the life of this Member.",
            "readOnly":true
        },
        "memberName":{
            "type":"string",
            "description":"A configured name that must be unique for every Member.",
            "readOnly":true
        },
        "receiverPacketUtilization":{
            "type":"number",
            "format":"float",
            "description":"The receiver packet utilization for this cluster node since the socket was last reopened. This value is a ratio of the number of bytes received to the number that would have been received had all packets been full. A low utilization indicates that data is not being sent in large enough chunks to make efficient use of the network.",
            "readOnly":true
        },
        "packetDeliveryEfficiency":{
            "type":"number",
            "format":"float",
            "description":"The efficiency of packet loss detection and retransmission.  A low efficiency is an indication that there is a high rate of unnecessary packet retransmissions.",
            "readOnly":true
        },
        "guardTerminateCount":{
            "type":"integer",
            "format":"int32",
            "description":"The number of termination attempts executed for all guardables on this node since the node statistics were last reset.",
            "readOnly":true
        },
        "machineId":{
            "type":"integer",
            "format":"int32",
            "description":"The Member`s machine Id.",
            "readOnly":true
        },
        "receiverSuccessRate":{
            "type":"number",
            "format":"float",
            "description":"The receiver success rate for this cluster node since the node statistics were last reset. Receiver success rate is a ratio of the number of packets successfully acknowledged in a first attempt to the total number of received packets. A failure count is incremented when a re-delivery of previously received packet is detected. It could be caused by either very high inbound network latency or lost ACK packets.",
            "readOnly":true
        },
        "memoryAvailableMB":{
            "type":"integer",
            "format":"int32",
            "description":"The total amount of memory in the JVM available for new objects in MB.",
            "readOnly":true
        },
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "description":"The date/time value (in cluster time) that this Member joined the cluster.",
            "readOnly":true
        },
        "unicastAddress":{
            "type":"string",
            "description":"The IP address of the Member`s DatagramSocket for point-to-point communication.",
            "readOnly":true
        },
        "weakestChannel":{
            "type":"integer",
            "format":"int32",
            "description":"The id of the cluster node to which this node is having the most difficulty communicating, or -1 if none is found.  A channel is considered to be weak if either the point-to-point publisher or receiver success rates are below 1.0.",
            "readOnly":true
        },
        "cpuCount":{
            "type":"integer",
            "format":"int32",
            "description":"Number of CPU cores for the machine this Member is running on.",
            "readOnly":true
        },
        "loggingLimit":{
            "type":"integer",
            "format":"int32",
            "description":"The maximum number of characters that the logger daemon will process from the message queue before discarding all remaining messages in the  queue. Valid values are integers in the range [0...]. Zero implies no limit.",
            "readOnly":false
        },
        "flowControlEnabled":{
            "type":"boolean",
            "description":"Indicates whether or not FlowControl is enabled.",
            "readOnly":true
        },
        "tcpRingFailures":{
            "type":"integer",
            "format":"int64",
            "description":"The number of recovered TcpRing disconnects since the node statistics were last reset. A recoverable disconnect is an abnormal event that is registered when the TcpRing peer drops the TCP connection, but recovers after no more then maximum configured number of attempts.This value will be -1 if the TcpRing is disabled.",
            "readOnly":true
        },
        "wellKnownAddresses":{
            "type":"array",
            "description":"An array of well-known socket addresses that this Member uses to join the cluster.",
            "items":{
                "type":"string"
            },
            "readOnly":true
        },
        "packetsResentExcess":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of packet retransmissions which were later proven unnecessary.",
            "readOnly":true
        },
        "nackSent":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of NACK packets sent since the node statistics were last reset.",
            "readOnly":true
        },
        "bufferPublishSize":{
            "type":"integer",
            "format":"int32",
            "description":"The buffer size of the unicast datagram socket used by the Publisher, measured in the number of packets. Changing this value at runtime is an inherently unsafe operation that will pause all network communications and may result in the termination of all cluster services.",
            "readOnly":false
        },
        "loggingLevel":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies which logged messages will be output to the log destination. Valid values are non-negative integers or -1 to disable all logger output.",
            "readOnly":false
        },
        "packetsResentEarly":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of packets resent ahead of schedule. A packet is resent ahead of schedule when there is a NACK indicating that the packet has not been received.",
            "readOnly":true
        },
        "statistics":{
            "type":"string",
            "description":"Statistics for this cluster node in a human readable format.",
            "readOnly":true
        },
        "packetsRepeated":{
            "type":"integer",
            "format":"int64",
            "description":"The number of duplicate packets received since the node statistics were last reset.",
            "readOnly":true
        },
        "publisherPacketUtilization":{
            "type":"number",
            "format":"float",
            "description":"The publisher packet utilization for this cluster node since the node socket was last reopened. This value is a ratio of the number of bytes sent to the number that would have been sent had all packets been full. A low utilization indicates that data is not being sent in large enough chunks to make efficient use of the network.",
            "readOnly":true
        },
        "packetsBundled":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of packets which were bundled prior to transmission. The total number of network transmissions is equal to (PacketsSent - PacketsBundled).",
            "readOnly":true
        },
        "rackName":{
            "type":"string",
            "description":"A configured name that should be the same for Members that are on the same physical \"rack\" (or frame or cage), and different for Members that are on different physical \"racks\".",
            "readOnly":true
        },
        "packetsResent":{
            "type":"integer",
            "format":"int64",
            "description":"The number of packets resent since the node statistics were last reset. A packet is resent when there is no ACK received within a timeout period.",
            "readOnly":true
        },
        "multicastPort":{
            "type":"integer",
            "format":"int32",
            "description":"The port of the Member`s MulticastSocket for group communication.",
            "readOnly":true
        },
        "quorumStatus":{
            "type":"string",
            "description":"The current state of the cluster quorum.",
            "readOnly":true
        },
        "tracingSamplingRatio":{
            "type":"number",
            "format":"float",
            "description":"The ratio of spans to trace when tracing is enabled.",
            "readOnly":false
        }
    }
}

Nested Schema : wellKnownAddresses

Type: array

Read Only: true

An array of well-known socket addresses that this Member uses to join the cluster.

Show Source

• Array of: string

{
    "type":"array",
    "description":"An array of well-known socket addresses that this Member uses to join the cluster.",
    "items":{
        "type":"string"
    },
    "readOnly":true
}

Back to Top