View This Server Runtime Collection
/management/weblogic/{version}/domainRuntime/serverRuntimes
View this server runtime collection.
Note: Monitors all the running servers in the WebLogic Server domain from the administration server. From this resource, you can monitor each managed server.
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 server runtime entities.
object
-
activationTime(optional):
integer(int64)
Read Only:
true
The time when the server was started.
-
administrationPortEnabled(optional):
boolean
Read Only:
true
Indicates whether the administration port is enabled on the server
-
administrationURL(optional):
string
Read Only:
true
The URL that the server and its clients use for administrative connections.
If no administration channel is enabled, then this method returns the URL for connections through the default channel. If the default channel is de-activated, this method returns the URL for a secure channel. If no secure channel is enabled, the method returns null.
The returned URL will be consistent with dynamic channel updates.
Constraints
- unharvestable
-
adminServer(optional):
boolean
Read Only:
true
Indicates whether the server is an Administration Server.
-
adminServerHost(optional):
string
Read Only:
true
The address on which the Administration Server is listening for connections. For example, this might return the string: santiago
-
adminServerListenPort(optional):
integer(int32)
Read Only:
true
The port on which the Administration Server is listening for connections.
-
adminServerListenPortSecure(optional):
boolean
Read Only:
true
Indicates whether the port that the server uses for administrative traffic is configured to use a secure protocol.
-
currentDirectory(optional):
string
Read Only:
true
The absolute path of the directory from which the server was started.
This may be used in conjunction with other relative paths in ServerMBean to compute full paths.
-
currentMachine(optional):
string
Return the machine on which the server is running. This will be different from the configuration if the server gets migrated automatically.
-
defaultURL(optional):
string
Read Only:
true
The URL that clients use to connect to this server's default network channel.
The returned value indicates the default protocol, listen address and listen port:
protocol://listen-addresslisten-port
Note: The default protocol, listen address and listen port are persisted in the domain's
config.xml
file, however when a server instance is started, command-line options can override these persisted values. ThisgetDefaultURL
method returns the URL values that are currently being used, not necessarily the values that are specified inconfig.xml
The returned URL will be consistent with dynamic channel updates.
Constraints
- unharvestable
-
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.
-
inSitConfigState(optional):
boolean
Read Only:
true
Returns true if sitconfig is applied.
-
listenPortEnabled(optional):
boolean
Read Only:
true
Indicates whether the default listen port is enabled on the server.
-
middlewareHome(optional):
string
Read Only:
true
The Oracle Middleware installation directory.
-
name(optional):
string
Read Only:
true
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Constraints
- unharvestable
-
openSocketsCurrentCount(optional):
integer(int32)
Read Only:
true
The current number of sockets registered for socket muxing on this server.
-
overallHealthState(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.
-
patchList(optional):
array Items
Title:
Items
Read Only:true
Returns information about installed patches on the server as an array of Strings. Each element of the array describes a patch, which is of the form:
BugNumber;PatchID;DateApplied;Description
Constraints
- unharvestable
-
restartRequired(optional):
boolean
Read Only:
true
Indicates whether the server must be restarted in order to activate configuration changes.
-
serverClasspath(optional):
string
Read Only:
true
Get the classpath for this server including domain/lib contents that are automatically picked up and appended to the classpath.
-
SSLListenPortEnabled(optional):
boolean
Read Only:
true
Indicates whether the default SSL listen port is enabled on the server
-
state(optional):
string
Read Only:
true
The current life cycle state of this server.
For example, a server can be in a RUNNING state in which it can receive and process requests or in an ADMIN state in which it can receive only administrative requests.
-
stateVal(optional):
integer(int32)
Read Only:
true
Returns current state of the server as in integer. weblogic.management.runtime.ServerStates has more information about the available server states
-
type(optional):
string
Read Only:
true
Returns the type of the MBean.
Constraints
- unharvestable
-
weblogicHome(optional):
string
Read Only:
true
The directory where the WebLogic Server instance (server) is installed, without the trailing "/server".
-
weblogicVersion(optional):
string
Read Only:
true
The version of this WebLogic Server instance (server).
Constraints
- unharvestable
object
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.
-
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:
Items
This property indicates the cause of the reported state.
array
Items
true
Returns information about installed patches on the server as an array of Strings. Each element of the array describes a patch, which is of the form:
BugNumber;PatchID;DateApplied;Description
Constraints
- unharvestable
array
Items
This 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.
object
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.
-
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).