1. REST API for Managing Oracle Coherence
  2. Tasks
  3. Search

Search the Management API

post

/management/coherence/cluster/search

Use this endpoint to search the entire Coherence management API hierarchy.

Request

Body ()
Root Schema : searchInput
Type: object
Show Source
Example:
[
    {
        "description":"Get cluster name and size",
        "fields":[
            "clusterName",
            "clusterSize"
        ],
        "links":[
        ]
    },
    {
        "description":"Get node id and member name for all cluster members",
        "children":{
            "members":{
                "fields":[
                    "nodeId",
                    "memberName"
                ],
                "links":[
                ]
            }
        },
        "fields":[
        ],
        "links":[
        ]
    },
    {
        "description":"Get the name and type of all services",
        "children":{
            "services":{
                "fields":[
                    "name",
                    "type"
                ],
                "links":[
                ]
            }
        },
        "fields":[
        ],
        "links":[
        ]
    }
]
Nested Schema : children
Type: object
Show Source
Nested Schema : fields
Type: array
Show Source
Nested Schema : members
Type: object
Show Source
Nested Schema : services
Type: object
Show Source
Nested Schema : children
Type: object
Show Source
Nested Schema : fields
Type: array
Show Source
Nested Schema : platform
Type: object
Show Source
Nested Schema : children
Type: object
Show Source
Nested Schema : memory
Type: object
Show Source
Nested Schema : fields
Type: array
Show Source
Nested Schema : children
Type: object
Show Source
Nested Schema : fields
Type: array
Show Source
Nested Schema : children
Type: object
Show Source
Nested Schema : members
Type: object
Show Source
Nested Schema : fields
Type: array
Show Source
Back to Top

Response

Supported Media Types

200 Response

A successful request that returns a list of Coherence clusters
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : searchOutput
Match All
Show Source
Nested Schema : cluster
Type: object
Show Source
Nested Schema : searchOutput-allOf[1]
Type: object
Show Source
Nested Schema : memberIds
Type: array
Read Only: true
An array of all existing cluster member ids.
Show Source
Nested Schema : members
Type: array
Read Only: true
An array of all existing cluster members.
Show Source
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
Nested Schema : members
Type: object
Show Source
Nested Schema : services
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Match All
Show Source
Nested Schema : member
Type: object
Show Source
  • 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.
  • 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.
  • Read Only: true
    Number of CPU cores for the machine this Member is running on.
  • Read Only: true
    Indicates whether or not FlowControl is enabled.
  • Read Only: true
    The number of recovery attempts executed for all guardables on this node since the node statistics were last reset.
  • Read Only: true
    The number of termination attempts executed for all guardables on this node since the node statistics were last reset.
  • 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.
  • Read Only: true
    The location of the MBean server
  • Read Only: true
    The output device used by the logging system. Valid values are stdout, stderr, jdk, log4j, or a file name.
  • Specifies how messages will be formatted before being passed to the log destination
  • Specifies which logged messages will be output to the log destination. Valid values are non-negative integers or -1 to disable all logger output.
  • 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.
  • Read Only: true
    The Member`s machine Id.
  • 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.
  • Name of the cluster member
  • Read Only: true
    A configured name that must be unique for every Member.
  • Read Only: true
    The total amount of memory in the JVM available for new objects in MB.
  • Read Only: true
    The maximum amount of memory that the JVM will attempt to use in MB.
  • Read Only: true
    The IP address of the Member`s MulticastSocket for group communication.
  • 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.
  • Read Only: true
    The port of the Member`s MulticastSocket for group communication.
  • 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.
  • Read Only: true
    The time-to-live for multicast packets sent out on this Member`s MulticastSocket.
  • Read Only: true
    Indicates whether or not the early packet loss detection protocol is enabled.
  • Read Only: true
    The total number of NACK packets sent since the node statistics were last reset.
  • Read Only: true
    The ID of member to which the MBean belongs
  • 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.
  • 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).
  • Read Only: true
    The number of packets received since the node statistics were last reset.
  • Read Only: true
    The number of duplicate packets received since the node statistics were last reset.
  • 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.
  • 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.
  • Read Only: true
    The total number of packet retransmissions which were later proven unnecessary.
  • Read Only: true
    The number of packets sent since the node statistics were last reset.
  • Read Only: true
    The priority or "weight" of the Member; used to determine tie-breakers.
  • 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).
  • Read Only: true
    The product edition this Member is running. Possible values are Standard Edition (SE), Enterprise Edition (EE), Grid Edition (GE).
  • 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.
  • 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.
  • Read Only: true
    The current state of the cluster quorum.
  • 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".
  • 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.
  • 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.
  • Read Only: true
    The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Read Only: true
    Number of CPU sockets for the machine this Member is running on.
  • Read Only: true
    Statistics for this cluster node in a human readable format.
  • 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.
  • Read Only: true
    The date/time value (in cluster time) that this Member joined the cluster.
  • The maximum total number of packets in the send and resend queues that forces the publisher to pause client threads. Zero means no limit.
  • 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.
  • Read Only: true
    Allowed Values: [ "Node" ]
    The type of the MBean
  • 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.
  • Read Only: true
    The IP address of the Member`s DatagramSocket for point-to-point communication.
  • Read Only: true
    The port of the Member`s DatagramSocket for point-to-point communication.
  • 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
    Read Only: true
    An array of well-known socket addresses that this Member uses to join the cluster.
Nested Schema : items-allOf[1]
Type: object
Show Source
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
Nested Schema : members
Type: object
Show Source
Nested Schema : platform
Type: object
Show Source
Nested Schema : memory
Match All
Show Source
Nested Schema : jvmMemory
Type: object
Show Source
Nested Schema : heapMemoryUsage
Type: object
Read Only: true
Show Source
Nested Schema : nonHeapMemoryUsage
Type: object
Read Only: true
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Match All
Show Source
Nested Schema : service
Type: object
Show Source
Nested Schema : items-allOf[1]
Type: object
Show Source
Nested Schema : caches
Type: object
Show Source
Nested Schema : members
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Match All
Show Source
Nested Schema : cache
Type: object
Details of the particular cache.
Show Source
Nested Schema : items-allOf[1]
Type: object
Show Source
Nested Schema : members
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Match All
Show Source
Nested Schema : cacheMember
Type: object
Show Source
  • Read Only: true
    The average number of milliseconds per get() invocation since the last time statistics were reset. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache).
  • Read Only: true
    The average number of milliseconds per get() invocation that is a hit. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache).
  • Read Only: true
    The average number of milliseconds per get() invocation that is a miss. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache).
  • Read Only: true
    The average number of milliseconds per put() invocation since the cache statistics were last reset. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache).
  • The BatchFactor attribute is used to calculate the `soft-ripe` time for write-behind queue entries. A queue entry is considered to be `ripe` for a write operation if it has been in the write-behind queue for no less than the QueueDelay interval. The `soft-ripe` time is the point in time prior to the actual `ripe` time after which an entry will be included in a batched asynchronous write operation to the CacheStore (along with all other `ripe` and `soft-ripe` entries). This attribute is only applicable if asynchronous writes are enabled (i.e. the value of the QueueDelay attribute is greater than zero) and the CacheStore implements the storeAll() method. The value of the element is expressed as a percentage of the QueueDelay interval. Valid values are doubles in the interval [0.0, 1.0].
  • Read Only: true
    The rough number of cache hits since the last time statistics were reset. A cache hit is a read operation invocation (i.e. get()) for which an entry exists in this map.
  • Read Only: true
    The total number of milliseconds (since the last time statistics were reset) for the get() operations for which an entry existed in this map. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache).
  • Read Only: true
    The rough number of cache misses since the last time statistics were reset.
  • Read Only: true
    The total number of milliseconds ( since the last time statistics were reset) for the get() operations for which no entry existed in this map. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache).
  • Read Only: true
    The number of `prune` operations since the last time statistics were reset. A prune operation occurs every time the cache reaches its high watermark.
  • Read Only: true
    The total number of milliseconds for the prune operations since the last time statistics were reset.
  • Read Only: true
    The cache store type for this cache. Possible values include NONE, READ-ONLY, WRITE-THROUGH, WRITE-BEHIND.
  • Read Only: true
    The cache description.
  • eventInterceptorInfo
    Read Only: true
    An array of statistics for events processed by event interceptors.
  • Read Only: true
    The total number of events dispatched by the StorageManager since the last time the statistics were reset.
  • Read Only: true
    The number of evictions from the backing map managed by this StorageManager caused by entries expiry or insert operations that would make the underlying backing map to reach its configured size limit. The eviction count is used to audit the cache size in a static system. Cache Size = Insert Count - Remove Count - Eviction count. Therefore the eviction count is not reset by the reset statistics method.
  • The time-to-live for cache entries in milliseconds. Value of zero indicates that the automatic expiry is disabled. Change of this attribute will not affect already-scheduled expiry of existing entries.
  • The limit of the cache size measured in units. The cache will prune itself automatically once it reaches its maximum unit level. This is often referred to as the `high water mark` of the cache.
  • Read Only: true
    The rough probability (0 <= p <="1)" that the next invocation will be a hit, based on statistics collected since last time were reset.< div>
  • indexInfo
    Read Only: true
    An array of information for each index applied to the portion of the partitioned cache managed by the StorageManager. Each element is a string value that includes a ValueExtractor description, ordered flag (true to indicate that the contents of the index are ordered; false otherwise), and cardinality (number of unique values indexed).
  • Read Only: true
    The total units used by all indices on the associated cache.
  • Read Only: true
    The number of inserts into the backing map managed by this StorageManager. In addition to standard inserts caused by put and invoke operations or synthetic inserts caused by get operations with read-through backing map topology, this counter is incremented when distribution transfers move resources `into` the underlying backing map and is decremented when distribution transfers move data `out`. The insert count is used to audit the cache size in a static system. Cache Size = Insert Count - Remove Count - Eviction count. Therefore the insert count is not reset by the reset statistics method.
  • Read Only: true
    The number of filter-based listeners currently registered with the StorageManager.
  • Read Only: true
    The number of key-based listeners currently registered with the StorageManager.
  • Read Only: true
    The total number of listener registration requests processed by the StorageManager since the last time the statistics were reset.
  • Read Only: true
    The location of the MBean server
  • Read Only: true
    The number of locks currently granted for the portion of the partitioned cache managed by the StorageManager.
  • Read Only: true
    The number of pending lock requests for the portion of the partitioned cache managed by the StorageManager.
  • The number of units to which the cache will shrink when it prunes. This is often referred to as a `low water mark` of the cache.
  • Read Only: true
    A string representation of a query with the longest execution time exceeding the MaxQueryThresholdMillis since statistics were last reset.
  • Read Only: true
    The duration in milliseconds of the longest query execution since statistics were last reset.
  • A query execution threshold in milliseconds The longest query executing longer than this threshold will be reported by the MaxQueryDescription attribute.
  • Name of the cluster member
  • Read Only: true
    Determines if Units is measuring the memory usage of the cache. If true, Units * UnitFactor is the number of bytes consumed by the cache.
  • Read Only: true
    The name of the cache
  • Read Only: true
    The ID of member to which the MBean belongs
  • Read Only: true
    The average duration in milliseconds per non-optimized query execution since the statistics were last reset.
  • Read Only: true
    The total number of queries that could not be resolved or were partially resolved against indexes since statistics were last reset.
  • Read Only: true
    The total execution time in milliseconds for queries that could not be resolved or were partially resolved against indexes since statistics were last reset.
  • Read Only: true
    The average duration in milliseconds per optimized query execution since the statistics were last reset.
  • Read Only: true
    The total number of queries that were fully resolved using indexes since statistics were last reset.
  • Read Only: true
    The total execution time in milliseconds for queries that were fully resolved using indexes since statistics were last reset.
  • Read Only: true
    Deprecated - use attribute CacheStoreType instead.
  • Read Only: true
    Total number of times a query had to be re-evaluated due to a concurrent update since statistics were last reset. This statistics provides a measure of an impact of concurrent updates on the query perfomance. If the total number of queries is Q and the number of contentions is C then the expected performance degradation factor should be no more than (Q + C)/Q.
  • The number of seconds that an entry added to a write-behind queue will sit in the queue before being stored via a CacheStore. Applicable only for WRITE-BEHIND persistence type.
  • Read Only: true
    The size of the write-behind queue size. Applicable only for WRITE-BEHIND persistence type.
  • The RefreshFactor attribute is used to calculate the `soft-expiration` time for cache entries. Soft-expiration is the point in time prior to the actual expiration after which any access request for an entry will schedule an asynchronous load request for the entry. This attribute is only applicable for a ReadWriteBackingMap which has an internal LocalCache with scheduled automatic expiration. The value of this element is expressed as a percentage of the internal LocalCache expiration interval. Valid values are doubles in the interval[0.0, 1.0]. If zero, refresh-ahead scheduling will be disabled.
  • Read Only: true
    The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
  • Read Only: true
    The number of removes from the backing map managed by this StorageManager caused by operations such as clear, remove or invoke. The remove count is used to audit the cache size in a static system. Cache Size = Insert Count - Remove Count - Eviction count. Therefore the remove count is not reset by the reset statistics method.
  • The maximum size of the write-behind queue for which failed CacheStore write operations are requeued. If zero, the write-behind requeueing will be disabled. Applicable only for WRITE-BEHIND persistence type.
  • The cache service name
  • Read Only: true
    The number of entries in the cache.
  • Read Only: true
    The average number of entries stored per CacheStore write operation. A call to the store() method is counted as a batch of one, whereas a call to the storeAll() method is counted as a batch of the passed Map size. The value of this attribute is -1 if the persistence type is NONE.
  • Read Only: true
    The average time (in millis) spent per read operation; -1 if persistence type is NONE. This statistic is only tracked for caches associated with a CacheStore.
  • Read Only: true
    The average time (in millis) spent per write operation; -1 if persistence type is NONE. This statistic is only tracked for caches associated with a CacheStore.
  • Read Only: true
    The total number of CacheStore failures (load, store and erase operations); -1 if persistence type is NONE.
  • Read Only: true
    The cummulative time (in millis) spent on load operations; -1 if persistence type is NONE. This statistic is only tracked for caches associated with a CacheStore.
  • Read Only: true
    The total number of load operations; -1 if persistence type is NONE.
  • Read Only: true
    The cumulative time (in milliseconds) spent on store and erase operations; -1 if persistence type is NONE or READ-ONLY. This statistic is only tracked for caches associated with a CacheStore.
  • Read Only: true
    The total number of store and erase operations; -1 if persistence type is NONE or READ-ONLY.
  • Read Only: true
    Allowed Values: [ "front", "back" ]
    Tier of the cache.
  • Read Only: true
    The total number of get() operations since the last time statistics were reset.
  • Read Only: true
    The total number of milliseconds spent on get() operations since the last time statistics were reset. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache).
  • Read Only: true
    The total number of put() operations since the last time statistics were reset.
  • Read Only: true
    The total number of milliseconds spent on put() operations since the last time statistics were reset. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache).
  • triggerInfo
    Read Only: true
    An array of information for each trigger applied to the portion of the partitioned cache managed by the StorageManager. Each element is a string value that represents a human-readable description of the corresponding MapTrigger.
  • Read Only: true
    Allowed Values: [ "Cache" ]
    The type of the MBean
  • Read Only: true
    The factor by which the Units, LowUnits and HighUnits properties are adjusted. Using a BINARY unit calculator, for example, the factor of 1048576 could be used to count megabytes instead of bytes.
  • Read Only: true
    The size of the cache measured in units. This value needs to be adjusted by the UnitFactor.
Nested Schema : eventInterceptorInfo
Type: array
Read Only: true
An array of statistics for events processed by event interceptors.
Show Source
Nested Schema : indexInfo
Type: array
Read Only: true
An array of information for each index applied to the portion of the partitioned cache managed by the StorageManager. Each element is a string value that includes a ValueExtractor description, ordered flag (true to indicate that the contents of the index are ordered; false otherwise), and cardinality (number of unique values indexed).
Show Source
Nested Schema : triggerInfo
Type: array
Read Only: true
An array of information for each trigger applied to the portion of the partitioned cache managed by the StorageManager. Each element is a string value that represents a human-readable description of the corresponding MapTrigger.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Match All
Show Source
Nested Schema : serviceMember
Type: object
Show Source
Nested Schema : eventInterceptorInfo
Type: array
Read Only: true
An array of statistics for events processed by event interceptors.
Show Source
Nested Schema : transportBackloggedConnectionList
Type: array
Read Only: true
A list of currently backlogged connections on the service dedicated transport.
Show Source
Back to Top