Jump to

• Request
• Response

Modify This Server Runtime

post

/management/weblogic/{version}/serverRuntime

Modify this server runtime.

Request

Supported Media Types

• application/json

Path Parameters

• version: string
  The version of the WebLogic REST interface.

Header Parameters

• X-Requested-By: string
  The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.

Body ()

Must contain the modified server runtime model.

Root Schema : Server Runtime

Type: object

Show Source

• 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. This getDefaultURL method returns the URL values that are currently being used, not necessarily the values that are specified in config.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

{
    "type":"object",
    "properties":{
        "SSLListenPortEnabled":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the default SSL listen port is enabled on the server</p>"
        },
        "activationTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The time when the server was started.</p>"
        },
        "adminServer":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the server is an Administration Server.</p>"
        },
        "adminServerHost":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The address on which the Administration Server is listening for connections. For example, this might return the string: santiago</p>"
        },
        "adminServerListenPort":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The port on which the Administration Server is listening for connections.</p>"
        },
        "adminServerListenPortSecure":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the port that the server uses for administrative traffic is configured to use a secure protocol.</p>"
        },
        "administrationPortEnabled":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the administration port is enabled on the server</p>"
        },
        "administrationURL":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The URL that the server and its clients use for administrative connections.</p><p>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.</p><p>The returned URL will be consistent with dynamic channel updates.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "currentDirectory":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The absolute path of the directory from which the server was started.</p><p>This may be used in conjunction with other relative paths in ServerMBean to compute full paths.</p>"
        },
        "currentMachine":{
            "type":"string",
            "description":"<p>Return the machine on which the server is running. This will be different from the configuration if the server gets migrated automatically.</p>"
        },
        "defaultURL":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The URL that clients use to connect to this server's default network channel.</p><p>The returned value indicates the default protocol, listen address and listen port:</p><p><i>protocol</i>://<i>listen-address</i><i>listen-port</i></p><p>Note: The default protocol, listen address and listen port are persisted in the domain's <code>config.xml</code> file, however when a server instance is started, command-line options can override these persisted values. This <code>getDefaultURL</code> method returns the URL values that are currently being used, not necessarily the values that are specified in <code>config.xml</code></p><p>The returned URL will be consistent with dynamic channel updates.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "healthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "inSitConfigState":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Returns true if sitconfig is applied.</p>"
        },
        "listenPortEnabled":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the default listen port is enabled on the server.</p>"
        },
        "middlewareHome":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The Oracle Middleware installation directory. </p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "openSocketsCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The current number of sockets registered for socket muxing on this server.</p>"
        },
        "overallHealthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "patchList":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>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: </p><p>BugNumber;PatchID;DateApplied;Description</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "restartRequired":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the server must be restarted in order to activate configuration changes.</p>"
        },
        "serverClasspath":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Get the classpath for this server including domain/lib contents that are automatically picked up and appended to the classpath.</p>"
        },
        "state":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The current life cycle state of this server.</p><p>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.</p>"
        },
        "stateVal":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Returns current state of the server as in integer. weblogic.management.runtime.ServerStates has more information about the available server states</p>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "weblogicHome":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The directory where the WebLogic Server instance (server) is installed, without the trailing \"/server\".</p>"
        },
        "weblogicVersion":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The version of this WebLogic Server instance (server).</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        }
    },
    "description":""
}

Nested Schema : Health State

Type: 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.

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "partitionName":{
            "type":"string",
            "description":"<p>This property indicates the partition name for which the health state is reported.</p>"
        },
        "state":{
            "type":"string",
            "description":"<p>This property indicates the reported state as:</p><ul><li><p>OK - Service is healthy.</p></li><li><p>WARN -  Service could have problems in the future</p></li><li><p>CRITICAL - Something must be done now to prevent service failure</p></li><li><p>FAILED - Service has failed and must be restarted</p></li><li><p>OVERLOADED -  Service is functioning normally but there is too much work in it</p></li><li><p>UNKNOWN - Service state cannot be determined</p></li></ul>"
        },
        "subsystemName":{
            "type":"string",
            "description":"<p>This property indicates the service for which the health state is reported.</p>"
        },
        "symptoms":{
            "title":"Items",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Symptom"
            },
            "description":"<p>This property indicates the cause of the reported state.</p>"
        }
    },
    "description":"<p>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.</p>"
}

Nested Schema : Items

Type: array

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

Show Source

• Array of: string

{
    "readOnly":true,
    "x-weblogic-unharvestable":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>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: </p><p>BugNumber;PatchID;DateApplied;Description</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
}

Nested Schema : Items

Type: array

Title: Items

This property indicates the cause of the reported state.

Show Source

• 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.

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Symptom"
    },
    "description":"<p>This property indicates the cause of the reported state.</p>"
}

Nested Schema : Symptom

Type: 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.

Show Source

• 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).

{
    "type":"object",
    "properties":{
        "info":{
            "type":"string",
            "description":"<p>This property provides additional information about the symptom if available.</p>"
        },
        "instanceId":{
            "type":"string",
            "description":"<p>This property represents an identifier for the symptom.</p>"
        },
        "severity":{
            "type":"string",
            "description":"<p>This property indicates a low, medium, or high severity level.</p>"
        },
        "type":{
            "type":"string",
            "description":"<p>This property represents the cause of the symptom (low memory, network error, stuck threads, and so on).</p>"
        }
    },
    "description":"<p>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.</p>"
}

Back to Top

Response

200 Response

Back to Top