View This Cluster Runtime
/management/weblogic/{version}/serverRuntime/clusterRuntime
View this cluster runtime.
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:
basicDescription:A user in the Admin security role. -
Deployer: basic
Type:
basicDescription:A user in the Deployer security role. -
Monitor: basic
Type:
basicDescription:A user in the Monitor security role. -
Operator: basic
Type:
basicDescription:A user in the Operator security role.
Response
- application/json
200 Response
Returns this cluster runtime.
This method can return the following links:
- rel=action title=initiateResourceGroupMigration uri=/management/weblogic/{version}/serverRuntime/clusterRuntime/initiateResourceGroupMigration
This resource's initiateResourceGroupMigration action resource.
- rel=jobSchedulerRuntime uri=/management/weblogic/{version}/serverRuntime/clusterRuntime/jobSchedulerRuntime
This resource's jobSchedulerRuntime singleton resource.
- rel=serverMigrationRuntime uri=/management/weblogic/{version}/serverRuntime/clusterRuntime/serverMigrationRuntime
This resource's serverMigrationRuntime singleton resource.
- rel=unicastMessaging uri=/management/weblogic/{version}/serverRuntime/clusterRuntime/unicastMessaging
This resource's unicastMessaging singleton resource.
object-
activeSingletonServices(optional):
array Items
Title:
ItemsRead Only:trueReturns an array of the names of the singleton services that are active on this server.
-
aliveServerCount(optional):
integer(int32)
Read Only:
trueProvides the current total number of alive servers in this cluster.
Returns the current total number of alive servers in this cluster.
-
detailedSecondariesDistribution(optional):
array Items
Title:
ItemsRead Only:trueProvides the names of the remote servers (such as myserver) for which the local server is hosting secondary objects. The name is appended with a number to indicate the number of secondaries hosted on behalf of that server.
-
foreignFragmentsDroppedCount(optional):
integer(int64)
Read Only:
trueProvides the number of fragments that originated in foreign domains or clusters which use the same multicast address.
Answer the number of fragments that originated in foreign domains/cluster that use the same multicast address.
-
fragmentsReceivedCount(optional):
integer(int64)
Read Only:
trueProvides the total number of messages received on this server from the cluster. This is applicable to both multicast and unicast message types.
-
fragmentsSentCount(optional):
integer(int64)
Read Only:
trueReturns the total number of message fragments sent from this server into the cluster. This is applicable to both multicast and unicast message types.
-
healthState(optional):
object Health State
Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.
-
multicastMessagesLostCount(optional):
integer(int64)
Read Only:
trueProvides the total number of in-coming multicast messages that were lost according to this server.
-
name(optional):
string
Read Only:
trueThe name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Constraints
- unharvestable
-
primaryCount(optional):
integer(int64)
Read Only:
trueProvides the number of object that the local server hosts as primaries.
Answer the number of object that the local server hosts as primaries.
-
resendRequestsCount(optional):
integer(int64)
Read Only:
trueProvides the number of state-delta messages that had to be resent because a receiving server in the cluster missed a message.
Returns the number of state-delta messages that had to be resent because a receiving server in the cluster missed a message.
-
secondaryCount(optional):
integer(int64)
Read Only:
trueAnswer the number of object that the local server hosts as secondaries.
-
secondaryServerDetails(optional):
string
Read Only:
true -
serverNames(optional):
array Items
Title:
ItemsRead Only:trueProvides the names of the servers in the cluster.
-
type(optional):
string
Read Only:
trueReturns the type of the MBean.
Constraints
- unharvestable
arrayItemstrueReturns an array of the names of the singleton services that are active on this server.
arrayItemstrueProvides the names of the remote servers (such as myserver) for which the local server is hosting secondary objects. The name is appended with a number to indicate the number of secondaries hosted on behalf of that server.
objectRepresents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.
-
partitionName(optional):
string
This property indicates the partition name for which the health state is reported.
-
state(optional):
string
This property indicates the reported state as:
OK - Service is healthy.
WARN - Service could have problems in the future
CRITICAL - Something must be done now to prevent service failure
FAILED - Service has failed and must be restarted
OVERLOADED - Service is functioning normally but there is too much work in it
UNKNOWN - Service state cannot be determined
-
subsystemName(optional):
string
This property indicates the service for which the health state is reported.
-
symptoms(optional):
array Items
Title:
ItemsThis property indicates the cause of the reported state.
arrayItemstrueProvides the names of the servers in the cluster.
arrayItemsThis property indicates the cause of the reported state.
-
Array of:
object Symptom
Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.
objectRepresents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.
-
info(optional):
string
This property provides additional information about the symptom if available.
-
instanceId(optional):
string
This property represents an identifier for the symptom.
-
severity(optional):
string
This property indicates a low, medium, or high severity level.
-
type(optional):
string
This property represents the cause of the symptom (low memory, network error, stuck threads, and so on).