View This System Component Collection
/management/weblogic/{version}/serverConfig/systemComponents
View this system component 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 system component entities.
object
-
autoRestart(optional):
boolean
Default Value:
true
Specifies whether the Node Manager can automatically restart this server if it crashes or otherwise goes down unexpectedly.
-
componentType(optional):
string
Get the system component type Examples of types may include "OHS", "Coherence". New System Components may be added in the future so the list of types is not static.
-
dynamicallyCreated(optional):
boolean
Read Only:
true
Default Value:false
Return whether the MBean was created dynamically or is persisted to config.xml
-
id(optional):
integer(int64)
Read Only:
true
Return the unique id of this MBean instance
-
machine(optional):
array Machine Reference
Title:
Machine Reference
Contains the machine reference.The WebLogic Server host computer (machine) on which this server is meant to run.
If you want to use a Node Manager to start this server, you must assign the server to a machine and you must configure the machine for the Node Manager.
You cannot change this value if a server instance is already running.
Constraints
- restart required
-
name(optional):
string
Read Only:
true
An alphanumeric name for this server instance. (Spaces are not valid.)
The name must be unique for all configuration objects in the domain. Within a domain, each server, machine, cluster, JDBC connection pool, virtual host, and any other resource type must be named uniquely and must not use the same name as the domain.
The server name is not used as part of the URL for applications that are deployed on the server. It is for your identification purposes only. The server name displays in the Administration Console, and if you use WebLogic Server command-line utilities or APIs, you use this name to identify the server.
After you have created a server, you cannot change its name. Instead, clone the server and provide a new name for the clone.
-
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.
-
restartDelaySeconds(optional):
integer(int32)
Minimum Value:
0
Maximum Value:2147483647
Default Value:0
The number of seconds the Node Manager should wait before restarting this server.
After killing a server process, the system might need several seconds to release the TCP port(s) the server was using. If Node Manager attempts to restart the Managed Server while its ports are still active, the startup attempt fails.
If AutoMigration is enabled and RestartDelaySeconds is 0, the RestartDelaySeconds is automatically set to the lease time. This prevents the server from failing to restart after migration when the previous lease is still valid.
-
restartIntervalSeconds(optional):
integer(int32)
Minimum Value:
300
Maximum Value:2147483647
Default Value:3600
The number of seconds during which this server can be restarted, up to the number of times specified in RestartMax.
-
restartMax(optional):
integer(int32)
Minimum Value:
0
Maximum Value:2147483647
Default Value:2
The number of times that the Node Manager can restart this server within the interval specified in RestartIntervalSeconds.
-
tags(optional):
array Items
Title:
Items
Return all tags on this Configuration MBean
-
type(optional):
string
Read Only:
true
Returns the type of the MBean.
Constraints
- unharvestable
array
Machine Reference
The WebLogic Server host computer (machine) on which this server is meant to run.
If you want to use a Node Manager to start this server, you must assign the server to a machine and you must configure the machine for the Node Manager.
You cannot change this value if a server instance is already running.
Constraints
- restart required