View This Coherence Cluster System Resource Collection
/management/weblogic/{version}/serverConfig/coherenceClusterSystemResources
View this coherence cluster system resource collection.
Request
-
version: string
The version of the WebLogic REST interface.
-
excludeFields(optional): string
The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
-
excludeLinks(optional): string
The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
-
fields(optional): string
The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
-
links(optional): string
The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.
-
Admin: basic
Type:
basic
Description:A user in the Admin security role.
-
Deployer: basic
Type:
basic
Description:A user in the Deployer security role.
-
Monitor: basic
Type:
basic
Description:A user in the Monitor security role.
-
Operator: basic
Type:
basic
Description:A user in the Operator security role.
Response
- application/json
200 Response
Returns a list of coherence cluster system resource entities.
object
-
clusterHosts(optional):
array Items
Title:
Items
Read Only:true
The list of hostnames of the managed servers belonging to this Coherence cluster.
-
compatibilityName(optional):
string
This is only set for beans created as a result of conversion from an 8.1 application configured using ApplicationMBean and ComponentMBean.
Standalone modules in 8.1 have both an ApplicationMBean name and ComponentMBean name. This attribute stores the name of the latter, to be used when the server creates the transient ComponentMBean for backward compatibility.
-
customClusterConfigurationFileName(optional):
string
Read Only:
true
The external custom Coherence cluster configuration file.
-
customConfigFileLastUpdatedTime(optional):
integer(int64)
Read Only:
true
The time when the custom configuration file used by the cluster was last updated
-
deploymentOrder(optional):
integer(int32)
Default Value:
100
An integer value that indicates when this unit is deployed, relative to other deployable units on a server, during startup.
Units with lower values are deployed before those with higher values.
-
deploymentPrincipalName(optional):
string
A string value that indicates the principal that should be used when deploying the file or archive during startup and shutdown. This principal will be used to set the current subject when calling out into application code for interfaces such as ApplicationLifecycleListener. If no principal name is specified, then the anonymous principal will be used.
-
descriptorFileName(optional):
string
Read Only:
true
The name of the file that contains the module configuration. By default the file resides in the
DOMAIN_DIR/config/coherence/bean_name
directory.The module file derives its name from the bean name using the following pattern:
.xml Note that this is a read-only property that can only be set when the bean is created.
-
dynamicallyCreated(optional):
boolean
Read Only:
true
Default Value:false
Return whether the MBean was created dynamically or is persisted to config.xml
-
federationRemoteClusterListenPort(optional):
integer(int32)
Read Only:
true
The Coherence Cluster Listen Port of the remote participant.
-
federationRemoteClusterName(optional):
string
Read Only:
true
The Coherence Cluster Name of the remote participant cluster.
-
federationRemoteParticipantHosts(optional):
array Items
Title:
Items
Read Only:true
The list of remote participant hosts, who will be added as participants in the federation topology.
-
federationTopology(optional):
string
Read Only:
true
The federation topology.
-
id(optional):
integer(int64)
Read Only:
true
Return the unique id of this MBean instance
-
moduleType(optional):
string
The values match those defined by jsr88. This attribute may move to another MBean.
-
name(optional):
string
Read Only:
true
The user-specified name of this MBean instance.
This name is included as one of the key properties in the MBean's
javax.management.ObjectName
Name=user-specified-name
Constraints
- legal null
-
notes(optional):
string
Optional information that you can include to describe this configuration.
WebLogic Server saves this note in the domain's configuration file (
config.xml
) as XML PCDATA. All left angle brackets (<) are converted to the xml entity<. Carriage returns/line feeds are preserved.)>
Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
-
persistenceActiveDirectory(optional):
string
Read Only:
true
The active directory for the default persistence environment. If no value is specified, the directory which will be used is the coherence/active sub-directory under Domain Home directory.
-
persistenceDefaultMode(optional):
string
Read Only:
true
The default persistence mode.
-
persistenceSnapshotDirectory(optional):
string
Read Only:
true
The snapshot directory for the default persistence environment. If no value is specified, the directory which will be used is coherence/snapshots sub-directory under Domain Home directory.
-
persistenceTrashDirectory(optional):
string
Read Only:
true
The trash directory for the default persistence environment. If no value is specified, the directory which will be used is coherence/trash sub-directory under Domain Home directory.
-
reportGroupFile(optional):
string
Default Value:
em/metadata/reports/coherence/report-group.xml
Get the report group file representing the superset of runtime metrics to be collected for this cluster.
-
resource(optional):
array Descriptor Reference
Title:
Descriptor Reference
Read Only:true
Contains the descriptor reference.Return the Descriptor for the system resource. This should be overridden by the derived system resources.
-
sourcePath(optional):
string
-
tags(optional):
array Items
Title:
Items
Return all tags on this Configuration MBean
-
targets(optional):
array Target References
Title:
Target References
Contains the array of target references.You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.
-
type(optional):
string
Read Only:
true
Returns the type of the MBean.
Constraints
- unharvestable
-
usingCustomClusterConfigurationFile(optional):
boolean
Specifies whether you are using a custom external Coherence cluster configuration file.
array
Items
true
The list of hostnames of the managed servers belonging to this Coherence cluster.
array
Items
true
The list of remote participant hosts, who will be added as participants in the federation topology.
array
Descriptor Reference
true
Return the Descriptor for the system resource. This should be overridden by the derived system resources.
array
Target References
You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.
-
Array of:
object Target Reference
Title:
Target Reference
Contains the target reference.
object
Target Reference
-
identity(optional):
array Identity
Title:
Identity
DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
array
Identity