REST API Reference for Managing Oracle Coherence

Cluster REST Endpoints

Cluster

The Cluster resource provides a set of endpoints for managing a Coherence cluster and cluster members. Use this resource to access operational information, performance statistics and logs and to shutdown cluster members. Applications should initially use this resource to discover the cluster members and their associated member IDs. Member IDs are required to access management resources and endpoints that are specific to a cluster member.

Configure OpenTracing: Method: post
Path: /management/coherence/cluster/configureTracing
Get a get a full thread dump for the specified cluster member: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/state
Get member description.: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/description
Get the Coherence Cluster Configuration: Method: get
Path: /management/coherence/cluster/getClusterConfig
Get the Coherence Cluster description: Method: get
Path: /management/coherence/cluster/description
Log Member State: Method: post
Path: /management/coherence/cluster/logMemberState
Log Member State: Method: post
Path: /management/coherence/cluster/members/{memberIdentifier}/logMemberState
Log the Cluster State: Method: post
Path: /management/coherence/cluster/logClusterState
Perform a Cluster wide Java Flight Recorder (JFR) operation: Method: post
Path: /management/coherence/cluster/diagnostic-cmd/{jfrCmd}
Perform a Heap Dump: Method: post
Path: /management/coherence/cluster/dumpClusterHeap
Perform a Heap Dump for a Cluster Member: Method: post
Path: /management/coherence/cluster/members/{memberIdentifier}/dumpHeap
Perform a JFR operation for a Cluster Member: Method: post
Path: /management/coherence/cluster/members/{memberIdentifier}/diagnostic-cmd/{jfrCmd}
Reset Member Statistics: Method: post
Path: /management/coherence/cluster/members/{memberIdentifier}/resetStatistics
Reset Member Statistics for all the members: Method: post
Path: /management/coherence/cluster/resetStatistics
Shutdown a Cluster Member: Method: post
Path: /management/coherence/cluster/members/{memberIdentifier}/shutdown
Shutdown the Cluster: Method: post
Path: /management/coherence/cluster/shutdown
Track the Weakest Cluster Member: Method: post
Path: /management/coherence/cluster/members/{memberIdentifier}/networkStats/trackWeakest
Track the Weakest Cluster Member for all the members: Method: post
Path: /management/coherence/cluster/networkStats/trackWeakest
Update a Member: Method: post
Path: /management/coherence/cluster/members/{memberIdentifier}
Update cluster configuration parameters on all the Members.: Method: post
Path: /management/coherence/cluster
View Cluster Information: Method: get
Path: /management/coherence/cluster
View Cluster Members: Method: get
Path: /management/coherence/cluster/members
View JVM details and system properties for the specified cluster member: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/environment
View Member Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}
View Network Statistics Between Members: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/networkStats