1 Resources

This documentation describes the Oracle WebLogic Server RESTful domain runtime resources that are used to monitor the entire WLS domain.

For a complete listing of the WLS REST reference documents and descriptions of their use, see Administering Oracle WebLogic Server with RESTful Management Services.

/management/weblogic

This resource is used to access different versions (if applicable) of the resources that are in this domain.

For the 12.2.1 release, there are just two versions: 12.2.1 and latest, where latest is another name for 12.2.1. For future releases, latest always refers to the most recent release.

To always use the latest resources, make sure to use latest in the URLs. Note that this might require updating a client when moving to a newer version of WebLogic Server. To fix the version so that an update is not required, use 12.2.1 in the URLs.

The resource supports the following methods:

GET

Get this collection of weblogic.management.rest.bean.model.Version instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.rest.bean.model.Version entities.

This method can return the following links:

  • uri=/management/weblogic rel=canonical

    This resource.

  • uri=/management/weblogic/12.2.1.0 rel=current

    Access the latest version of the WLS resources in the this domain.

  • uri=/management/weblogic rel=self

    This resource.

Example

Example 1   View the versions collection.

This example uses the GET method to display the version instances in this collection.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [
        {
            "rel": "self",
            "href": "http:\//localhost:7001/management/weblogic"
        },
        {
            "rel": "canonical",
            "href": "http:\//localhost:7001/management/weblogic"
        },
        {
            "rel": "current",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.0"
        }
    ],
    "items": [{
        "links": [
            {
                "rel": "self",
                "href": "http:\//localhost:7001/management/12.2.1.0"
            },
            {
                "rel": "canonical",
                "href": "http:\//localhost:7001/management/12.2.1.0"
            }
        ],
        "version": "12.2.1.0",
        "isLatest": true,
        "lifecycle": "active"
    }]
}

/management/weblogic/{version}

This resource describes the resource trees that are used to manage a WebLogic Server domain and its managed servers. The resource trees mimic the bean trees in WLST and allow you to view and edit configuration and monitor runtime behavior.

The resource supports the following methods:

GET

Get this weblogic.management.rest.bean.model.Version instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.rest.bean.model.Version entity.

This method can return the following links:

  • uri=/management/weblogic/{version} rel=canonical

    This resource.

  • uri=/management/weblogic/{version}/currentUser rel=currentUser

  • uri=/management/weblogic/{version}/domainConfig rel=domainConfig

  • uri=/management/weblogic/{version}/domainRuntime rel=domainRuntime

  • uri=/management/weblogic/{version}/edit rel=edit

  • uri=/management/weblogic rel=parent

    The parent resource of this resource.

  • uri=/management/weblogic/{version} rel=self

    This resource.

  • uri=/management/weblogic/{version}/serverConfig rel=serverConfig

  • uri=/management/weblogic/{version}/serverRuntime rel=serverRuntime

Example

Example 1   View the latest version.

This example uses the GET method to display the latest version.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/latest

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [
        {
            "rel": "parent",
            "href": "http:\//localhost:7001/management/weblogic"
        },
        {
            "rel": "self",
            "href": "http:\//localhost:7001/management/weblogic/latest"
        },
        {
            "rel": "canonical",
            "href": "http:\//localhost:7001/management/weblogic/latest"
        },
        {
            "rel": "edit",
            "href": "http:\//localhost:7001/management/weblogic/latest/edit"
        },
        {
            "rel": "domainConfig",
            "href": "http:\//localhost:7001/management/weblogic/latest/domainConfig"
        },
        {
            "rel": "domainRuntime",
            "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime"
        },
        {
            "rel": "serverRuntime",
            "href": "http:\//localhost:7001/management/weblogic/latest/serverRuntime"
        },
        {
            "rel": "serverConfig",
            "href": "http:\//localhost:7001/management/weblogic/latest/serverConfig"
        },
        {
            "rel": "currentUser",
            "href": "http:\//localhost:7001/management/weblogic/latest/currentUser"
        }
    ],
    "version": "12.2.1.0",
    "isLatest": true,
    "lifecycle": "active"
}
Example 2   View a specific version.

This example uses the GET method to display a specific version.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/12.2.1.0

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [
        {
            "rel": "parent",
            "href": "http:\//localhost:7001/management/weblogic"
        },
        {
            "rel": "self",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.0"
        },
        {
            "rel": "canonical",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.0"
        },
        {
            "rel": "edit",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.0/edit"
        },
        {
            "rel": "domainConfig",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.0/domainConfig"
        },
        {
            "rel": "domainRuntime",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.0/domainRuntime"
        },
        {
            "rel": "serverRuntime",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.0/serverRuntime"
        },
        {
            "rel": "serverConfig",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.0/serverConfig"
        },
        {
            "rel": "currentUser",
            "href": "http:\//localhost:7001/management/weblogic/12.2.1.0/currentUser"
        }
    ],
    "version": "12.2.1.0",
    "isLatest": true,
    "lifecycle": "active"
}

/management/weblogic/{version}/currentUser

This resource represents an authenticated user in the domain.

The resource supports the following methods:

GET

Get this weblogic.management.rest.bean.model.CurrentUser instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.rest.bean.model.CurrentUser entity.

This method can return the following links:

Example

Example 1   Viewing the weblogic.management.rest.bean.model.CurrentUser Instance

This example uses the GET method to view this weblogic.management.rest.bean.model.CurrentUser instance.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/latest/currentUser

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [
        {
            "rel": "parent",
            "href": "http:\//localhost:7001/management/weblogic/latest"
        },
        {
            "rel": "self",
            "href": "http:\//localhost:7001/management/weblogic/latest/currentUser"
        },
        {
            "rel": "canonical",
            "href": "http:\//localhost:7001/management/weblogic/latest/currentUser"
        }
    ],
    "partitionId": "0",
    "partitionName": "DOMAIN",
    "user": "admin"
}

/management/weblogic/{version}/domainRuntime

This resource is used to monitor the entire WebLogic Server domain.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.DomainRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.DomainRuntimeMBean entity.

This method can return the following links:

Example

Example 1   Viewing the weblogic.management.runtime.DomainRuntimeMBean Instance

This example uses the GET method to view this weblogic.management.runtime.DomainRuntimeMBean instance.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/latest/domainRuntime?fields=activationTime&links=self

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [{
        "rel": "self",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime"
    }],
    "activationTime": "2015-08-14T00:25:21.830-04"
}

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime

This resource manages a weblogic.management.runtime.AppRuntimeStateRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.AppRuntimeStateRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.AppRuntimeStateRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getCurrentState

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Aggregate state for the application. This is defined as the most advanced state of the application's modules on the named target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

target

logical target where the app is deployed

Type: string

Response Body

Contains a JSON object with a string return field.

POST

Aggregate state for the module. This is defined as the most advanced state of the module on all servers associated with the named target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

target

logical target where module is deployed

Type: string

Response Body

Contains a JSON object with a string return field.

POST

Aggregate state for a submodule. This is defined as the most advanced state of the submodule on all servers associated with the named target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

subModuleId

subModuleId

Type: string

target

logical target where module is deployed

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getIntendedState

The resource supports the following methods:

POST

The resource supports the following methods:

POST

The state the application should be in.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a string return field.

POST

The state the application should be in on a specific target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

target

target

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleIds

The resource supports the following methods:

POST

Names of the modules contained in the application. This does not include submodules.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleTargets

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Logical targets where the submodule is deployed.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

subModuleId

subModuleId

Type: string

Response Body

Contains a JSON object with a array of string return field.

POST

Logical targets where the module is deployed.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getModuleType

The resource supports the following methods:

POST

Indicates the type of module: EAR, WAR, etc.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeMillis

The resource supports the following methods:

POST

The time when the application will be retired.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a long return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getRetireTimeoutSeconds

The resource supports the following methods:

POST

The amount of time the application is given to retire.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a int return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/getSubmoduleIds

The resource supports the following methods:

POST

Submodules associated with this module.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isActiveVersion

The resource supports the following methods:

POST

Indicates if the application is the active version, the one that new sessions will use.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

is the application id

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime/isAdminMode

The resource supports the following methods:

POST

Indicates if the application should only be available through the administration port. This is the desired state of the application.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

is the application id

Type: string

target

target

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/batchJobRepositoryRuntime

This resource manages a weblogic.management.runtime.BatchJobRepositoryRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.BatchJobRepositoryRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.BatchJobRepositoryRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/consoleRuntime

This resource manages a weblogic.management.runtime.ConsoleRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.ConsoleRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ConsoleRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/consoleRuntime/getDefaultPageURL

The resource supports the following methods:

POST

Gets the URL for the default page of an object. You can optionally specify the kind of default page (e.g. configuration or monitoring). For example, use this method to get a WLS cluster's default page's URL. Use this method when possible since it isolates the caller from the specific console page labels. This method does not check whether the page exists. To find out, use the URL and see if it works.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

context

Identifies the object the page should display or manage. Most pages display or manage WLS mbeans (such as a server or cluster). For them, call "getObjectNameContext", passing in the JMX object name, to get the context to pass to this method. See the console programmers' guide for more information on contexts.

Type: array of string

perspective

Specifies which kind of default page to return (e.g. configuration or monitoring). Pass in null to get the default page for the object. See the console programmers' guide for more information on perspectives.

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/consoleRuntime/getDefaultPageURLs

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Gets the URLs for the default pages for a set of objects. This method works exactly like getDefaultPageURL, except that it lets you get the URLS for a set of pages in one JMX call (to increase network performance).

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

contexts

An array of contexts identifying the object each page should display or manage.

Type: array of array of string

perspectives

An array of perspectives identifying which kind of default page to return for each object.

Type: array of string

Response Body

Contains a JSON object with a array of string return field.

POST

Gets the URLs for the default pages for a set of objects. This method works exactly like getDefaultPageURL, except that it lets you get the URLS for a set of pages in one JMX call (to increase network performance).

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

contexts

An array of contexts identifying the object each page should display or manage.

Type: array of array of string

perspective

Specifies which kind of default page to return for all of the pages.

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/consoleRuntime/getObjectNameContext

The resource supports the following methods:

POST

Gets a context for a WLS mbean. This method does not check whether the mbean exists. The results of this method are usually passed into getDefaultPageURL or getSpecificPageURL.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

objectName

the JMX object name of a WLS mbean

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/consoleRuntime/getSpecificPageURL

The resource supports the following methods:

POST

Gets the URL for a specific console page. For example, use this method to get a WLS server's SSL configuration page's URL or the servers table page's URL. Note: WLS reserves the right to change its portal page names in future releases. Therefore, customers are advised to use "getDefaultPageURL" if possible so that they'll be isolated from these kinds of changes. This method does not check whether the page exists. To find out, use the URL and see if it works.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

page

The portal page label of the desired console page.

Type: string

context

Identifies the object the page should display or manage. Most pages display or manage WLS mbeans (such as a server or cluster). For them, call "getObjectNameContext", passing in the JMX object name, to get the context to pass to this method. See the console programmers' guide for more information on contexts.

Type: array of string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/consoleRuntime/getSpecificPageURLs

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Gets the URLs for a set of specific console page. This method works exactly like getSpecificPageURL, except that it lets you get the URLS for a set of pages in one JMX call (to increase network performance).

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

page

The portal page label of the desired console pages.

Type: string

contexts

An array of contexts identifying the object each page should display or manage.

Type: array of array of string

Response Body

Contains a JSON object with a array of string return field.

POST

Gets the URLs for a set of specific console pages. This method works exactly like getSpecificPageURL, except that it lets you get the URLS for a set of pages in one JMX call (to increase network performance).

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

pages

An array of portal page labels of the desired console pages.

Type: array of string

contexts

An array of contexts identifying the object each page should display or manage.

Type: array of array of string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/deploymentManager

This resource manages a weblogic.management.runtime.DeploymentManagerMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.DeploymentManagerMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.DeploymentManagerMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes

This resource manages a collection of weblogic.management.runtime.AppDeploymentRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.AppDeploymentRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.AppDeploymentRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}

This resource manages a weblogic.management.runtime.AppDeploymentRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.AppDeploymentRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.AppDeploymentRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/getState

The resource supports the following methods:

POST

The state of the application for a target. Notifications will be generated for this attribute on state changes. Valid states are those supported by the weblogic.management.runtime.AppRuntimeStateRuntimeMBean The notification types are appdeployment.created, appdeployment.deleted, appdeployment.state.new, appdeployment.state.prepared, appdeployment.state.admin, appdeployment.state.active, appdeployment.state.retired, appdeployment.state.failed, appdeployment.state.update.pending, and appdeployment.state.unknown. The userdata is a Map where the keys are target names and the values are the application state for that target.

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

target

the target for the application state

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/redeploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Redeploy the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to redeploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be redeployed on all configured targets.

Type: array of string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Redeploy the application using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/start

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Start the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to start the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be started on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Start the application using the default options and configured targets. This is a synchronous operation that returns when the start operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/stop

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Stop the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to stop the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be stoped on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Stop the application using the default options and configured targets. This is a synchronous operation that returns when the stop operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/undeploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Undeploy the application using the default options and configured targets. This is a synchronous operation that returns when the undeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Undeploy the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to undeploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be undeployed on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/appDeploymentRuntimes/{name}/update

The resource supports the following methods:

POST

Allows for updating an application configuration using an changed deployment plan.

A configuration update is equivalent to replacing the application's deployment plan. The deployment plan is redeployed in-place. A new version of the application is not started, even if the new deployment plan has a different version.

The update succeeds only if changes to the deployment plan do not require the application to be restarted. Configuration changes in the new deployment plan must be limited to tuning the application. Changes to resource bindings causes the update to fail. Use redeploy() to apply resource binding changes to a production application.

This method targets only root modules. Module level targeting is not supported.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

represent the targets on which to update the application.

Type: array of string

plan

The deployment plan containing the new deployment configuration information.

Type: string

deploymentOptions

Allows for overriding the deployment options. May be null.

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/confirmApplicationName

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Used by the deployment subsystem to confirm an application name.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

isRedeployment

should be true in the case where this function is called for a redeployment.

Type: boolean

appSource

is a the path to the application.

Type: string

optional

alternate app descriptor.

Type: string

tentativeName

The name proposed for the application (provided by the user, or through the manifest). Null if no name was specified by the user or through the manifest.

Type: string

tentativeApplicationId

The tentative application ID. May only be null if the application is not versioned. If tentativeName is null and the application is versioned, this should be just the version string (which includes both the implementation and specification versions).

Type: string

deploymentOptions

deployment options

Type: java.util.Properties

Response Body

Contains a JSON object with a string return field.

POST

Used by the deployment subsystem to confirm an application name.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

isRedeployment

should be true in the case where this function is called for a redeployment.

Type: boolean

appSource

is a the path to the application.

Type: string

optional

alternate application descriptor path

Type: string

tentativeName

The name proposed for the application (provided by the user, or through the manifest). Null if no name was specified by the user or through the manifest.

Type: string

tentativeApplicationId

The tentative application ID. May only be null if the application is not versioned. If tentativeName is null and the application is versioned, this should be just the version string (which includes both the implementation and specification versions).

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/deploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

A convenience method for distributing and starting an application.

The application source files and deployment plan are distributed to the deployment targets using the default options. This is a synchronous operation that returns when the deploy operation has completed. If distribution is successful, the application is then started on each of the targets. Successful deployment requires that all targets receive both the archive and deployment plan.

The default options are

  • clusterDeploymentTimeout: 3600000 milliseconds

  • gracefulIgnoreSessions: false

  • gracefulProductionToAdmin: false

  • retireGracefully: true

  • retireTimeout: no timeout

  • adminMode: false

  • timeout: no timeout

If any modules are currently running, this method immediately restarts those modules using the newer files. Restarting modules in this manner is not the same as redeployment, because session state is not preserved for the active modules.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

A supported Java EE application or module archive, or a root directory for the application or module.

Type: string

plan

The deployment plan for this application. May be null.

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

A convenience method for distributing and starting an application. The application source files and deployment plan are distributed to the deployment targets using the options specified. This is an asynchronous operation that returns immediately. If distribution is successful, the application is then started on each of the targets. Successful deployment requires that all targets receive both the archive and deployment plan.

If any modules are currently running, this method immediately restarts those modules using the newer files. Restarting modules in this manner is not the same as redeployment, because session state is not preserved for the active modules.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

A supported Java EE application or module archive, or a root directory for the application or module.

Type: string

targets

The targets on which to deploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be redeployed on all configured targets.

Type: array of string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects

This resource manages a collection of weblogic.management.runtime.DeploymentProgressObjectMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.DeploymentProgressObjectMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.DeploymentProgressObjectMBean entities.

This method can return the following links:

Example

Example 1   View the weblogic.management.runtime.DeploymentProgressObjectMBean Collection

This example uses the GET method to display the weblogic.management.runtime.DeploymentProgressObjectMBean instances in this collection.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/latest/domainRuntime/deploymentManager/deploymentProgressObjects?fields=completed,progress,applicationName,operationType&links=none

Example Response

HTTP/1.1 200 OK

Response Body:
{"items": [{
    "operationType": 3,
    "applicationName": "fairShare",
    "progress": "success",
    "completed": true
}]}

/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}

This resource manages a weblogic.management.runtime.DeploymentProgressObjectMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.DeploymentProgressObjectMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.DeploymentProgressObjectMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/cancel

The resource supports the following methods:

POST

Attempt to cancel the deployment operation. Any actions which have yet to start will be inhibited. Any completed actions will remain in place.

Roles

Admin, Deployer

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/getExceptions

The resource supports the following methods:

POST

If the current deployment operation has failed, this method may return zero or more exception(s) which represent the errors for this target. The array will not contain WLS exception classes; instead they will be new RuntimeExceptions containing the stack traces and messages from the original WLS Exceptions.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

target

the target where exceptions might have occurred.

Type: string

Response Body

Contains a JSON object with a array of java.lang.Throwable return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/distribute

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Distribute an application.

The application source files and deployment plan are distributed to the deployment targets using the default options. This is a synchronous operation that returns when the distribute operation has completed.

The default options are:

  • clusterDeploymentTimeout: 3600000 milliseconds

  • gracefulIgnoreSessions: false

  • gracefulProductionToAdmin: false

  • retireGracefully: true

  • retireTimeout: no timeout

  • adminMode: false,

  • timeout: no timeout

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

A supported Java EE application or module archive, or a root directory for the application or module.

Type: string

plan

The deployment plan for this application. May be null.

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Distribute an application. The application source files and deployment plan are distributed to the deployment targets using the options specified. This is an asynchronous operation that returns immediately.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

A supported Java EE application or module archive, or a root directory for the application or module.

Type: string

targets

The targets on which to deploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be distributed on all configured targets.

Type: array of string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes

This resource manages a collection of weblogic.management.runtime.LibDeploymentRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.LibDeploymentRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.LibDeploymentRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}

This resource manages a weblogic.management.runtime.LibDeploymentRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.LibDeploymentRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.LibDeploymentRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/redeploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Redeploy the library in the background for the targets specified with the options specified. This is an synchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to redeploy the library. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the library will be redeployed on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The keys,units and default values for options are adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Redeploy the library using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are adminMode: false, timeout: no timeout

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/libDeploymentRuntimes/{name}/undeploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Undeploy the library using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are adminMode boolean false timeout: no timeout

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Undeploy the library in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to undeploy the library. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the library will be undeployed on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are adminMode boolean false timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/purgeCompletedDeploymentProgressObjects

The resource supports the following methods:

POST

Removes progress objects for completed operations.

Roles

Admin, Deployer

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/deploymentManager/redeploy

The resource supports the following methods:

POST

Redeploy the application that is deployed to a resource group template in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

Note that this API is only for redeploying applications or libraries that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for redeploying applications that are not deployed to a resource group template, and LibDeploymentRuntimeMBean should be used for redeploying libraries that are not deployed to a resource group template.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout) resourceGroupTemplate this value is required

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/undeploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Undeploy the application that is deployed to a resource group template using the default options. This is a synchronous operation that returns when the undeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

template

The resource group template

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Undeploy the application that is deployed to a resource group template in the background with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

Note that this API is only for undeploying applications that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for undeploying applications that are not deployed to a resource group template.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

deploymentOptions

Allows for overriding the deployment options. The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout) resourceGroupTemplate this value is required

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/deploymentManager/update

The resource supports the following methods:

POST

Allows for updating an application configuration using an changed deployment plan for applications deployed to a resource group template.

A configuration update is equivalent to replacing the application's deployment plan. The deployment plan is redeployed in-place. A new version of the application is not started, even if the new deployment plan has a different version.

The update succeeds only if changes to the deployment plan do not require the application to be restarted. Configuration changes in the new deployment plan must be limited to tuning the application. Changes to resource bindings causes the update to fail. Use redeploy(String, String, Properties) to apply resource binding changes to a production application.

This method targets only root modules. Module level targeting is not supported.

Note that this API is only for updating applications that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for updating applications that are not deployed to a resource group template.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout) resourceGroupTemplate this value is required

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes

This resource manages a collection of weblogic.management.runtime.DomainPartitionRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.DomainPartitionRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.DomainPartitionRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}

This resource manages a weblogic.management.runtime.DomainPartitionRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.DomainPartitionRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.DomainPartitionRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime

This resource manages a weblogic.management.runtime.AppRuntimeStateRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.AppRuntimeStateRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.AppRuntimeStateRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getCurrentState

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Aggregate state for the application. This is defined as the most advanced state of the application's modules on the named target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

target

logical target where the app is deployed

Type: string

Response Body

Contains a JSON object with a string return field.

POST

Aggregate state for the module. This is defined as the most advanced state of the module on all servers associated with the named target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

target

logical target where module is deployed

Type: string

Response Body

Contains a JSON object with a string return field.

POST

Aggregate state for a submodule. This is defined as the most advanced state of the submodule on all servers associated with the named target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

subModuleId

subModuleId

Type: string

target

logical target where module is deployed

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getIntendedState

The resource supports the following methods:

POST

The resource supports the following methods:

POST

The state the application should be in.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a string return field.

POST

The state the application should be in on a specific target.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

target

target

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleIds

The resource supports the following methods:

POST

Names of the modules contained in the application. This does not include submodules.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleTargets

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Logical targets where the submodule is deployed.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

subModuleId

subModuleId

Type: string

Response Body

Contains a JSON object with a array of string return field.

POST

Logical targets where the module is deployed.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getModuleType

The resource supports the following methods:

POST

Indicates the type of module: EAR, WAR, etc.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTimeMillis

The resource supports the following methods:

POST

The time when the application will be retired.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a long return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getRetireTimeoutSeconds

The resource supports the following methods:

POST

The amount of time the application is given to retire.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

Response Body

Contains a JSON object with a int return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/getSubmoduleIds

The resource supports the following methods:

POST

Submodules associated with this module.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

appid

Type: string

moduleid

moduleid

Type: string

Response Body

Contains a JSON object with a array of string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isActiveVersion

The resource supports the following methods:

POST

Indicates if the application is the active version, the one that new sessions will use.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

is the application id

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/appRuntimeStateRuntime/isAdminMode

The resource supports the following methods:

POST

Indicates if the application should only be available through the administration port. This is the desired state of the application.

Roles

Admin, Deployer, Monitor, Operator

Request Body

Must contain a JSON object with the following fields:

appid

is the application id

Type: string

target

target

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager

This resource manages a weblogic.management.runtime.DeploymentManagerMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.DeploymentManagerMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.DeploymentManagerMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes

This resource manages a collection of weblogic.management.runtime.AppDeploymentRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.AppDeploymentRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.AppDeploymentRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}

This resource manages a weblogic.management.runtime.AppDeploymentRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.AppDeploymentRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.AppDeploymentRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/getState

The resource supports the following methods:

POST

The state of the application for a target. Notifications will be generated for this attribute on state changes. Valid states are those supported by the weblogic.management.runtime.AppRuntimeStateRuntimeMBean The notification types are appdeployment.created, appdeployment.deleted, appdeployment.state.new, appdeployment.state.prepared, appdeployment.state.admin, appdeployment.state.active, appdeployment.state.retired, appdeployment.state.failed, appdeployment.state.update.pending, and appdeployment.state.unknown. The userdata is a Map where the keys are target names and the values are the application state for that target.

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

target

the target for the application state

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/redeploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Redeploy the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to redeploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be redeployed on all configured targets.

Type: array of string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Redeploy the application using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/start

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Start the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to start the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be started on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Start the application using the default options and configured targets. This is a synchronous operation that returns when the start operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/stop

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Stop the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to stop the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be stoped on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Stop the application using the default options and configured targets. This is a synchronous operation that returns when the stop operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/undeploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Undeploy the application using the default options and configured targets. This is a synchronous operation that returns when the undeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Undeploy the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to undeploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be undeployed on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/update

The resource supports the following methods:

POST

Allows for updating an application configuration using an changed deployment plan.

A configuration update is equivalent to replacing the application's deployment plan. The deployment plan is redeployed in-place. A new version of the application is not started, even if the new deployment plan has a different version.

The update succeeds only if changes to the deployment plan do not require the application to be restarted. Configuration changes in the new deployment plan must be limited to tuning the application. Changes to resource bindings causes the update to fail. Use redeploy() to apply resource binding changes to a production application.

This method targets only root modules. Module level targeting is not supported.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer, Operator

Request Body

Must contain a JSON object with the following fields:

targets

represent the targets on which to update the application.

Type: array of string

plan

The deployment plan containing the new deployment configuration information.

Type: string

deploymentOptions

Allows for overriding the deployment options. May be null.

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/confirmApplicationName

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Used by the deployment subsystem to confirm an application name.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

isRedeployment

should be true in the case where this function is called for a redeployment.

Type: boolean

appSource

is a the path to the application.

Type: string

optional

alternate app descriptor.

Type: string

tentativeName

The name proposed for the application (provided by the user, or through the manifest). Null if no name was specified by the user or through the manifest.

Type: string

tentativeApplicationId

The tentative application ID. May only be null if the application is not versioned. If tentativeName is null and the application is versioned, this should be just the version string (which includes both the implementation and specification versions).

Type: string

deploymentOptions

deployment options

Type: java.util.Properties

Response Body

Contains a JSON object with a string return field.

POST

Used by the deployment subsystem to confirm an application name.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

isRedeployment

should be true in the case where this function is called for a redeployment.

Type: boolean

appSource

is a the path to the application.

Type: string

optional

alternate application descriptor path

Type: string

tentativeName

The name proposed for the application (provided by the user, or through the manifest). Null if no name was specified by the user or through the manifest.

Type: string

tentativeApplicationId

The tentative application ID. May only be null if the application is not versioned. If tentativeName is null and the application is versioned, this should be just the version string (which includes both the implementation and specification versions).

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

A convenience method for distributing and starting an application.

The application source files and deployment plan are distributed to the deployment targets using the default options. This is a synchronous operation that returns when the deploy operation has completed. If distribution is successful, the application is then started on each of the targets. Successful deployment requires that all targets receive both the archive and deployment plan.

The default options are

  • clusterDeploymentTimeout: 3600000 milliseconds

  • gracefulIgnoreSessions: false

  • gracefulProductionToAdmin: false

  • retireGracefully: true

  • retireTimeout: no timeout

  • adminMode: false

  • timeout: no timeout

If any modules are currently running, this method immediately restarts those modules using the newer files. Restarting modules in this manner is not the same as redeployment, because session state is not preserved for the active modules.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

A supported Java EE application or module archive, or a root directory for the application or module.

Type: string

plan

The deployment plan for this application. May be null.

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

A convenience method for distributing and starting an application. The application source files and deployment plan are distributed to the deployment targets using the options specified. This is an asynchronous operation that returns immediately. If distribution is successful, the application is then started on each of the targets. Successful deployment requires that all targets receive both the archive and deployment plan.

If any modules are currently running, this method immediately restarts those modules using the newer files. Restarting modules in this manner is not the same as redeployment, because session state is not preserved for the active modules.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

A supported Java EE application or module archive, or a root directory for the application or module.

Type: string

targets

The targets on which to deploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be redeployed on all configured targets.

Type: array of string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects

This resource manages a collection of weblogic.management.runtime.DeploymentProgressObjectMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.DeploymentProgressObjectMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.DeploymentProgressObjectMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}

This resource manages a weblogic.management.runtime.DeploymentProgressObjectMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.DeploymentProgressObjectMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.DeploymentProgressObjectMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}/cancel

The resource supports the following methods:

POST

Attempt to cancel the deployment operation. Any actions which have yet to start will be inhibited. Any completed actions will remain in place.

Roles

Admin, Deployer

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/deploymentProgressObjects/{name}/getExceptions

The resource supports the following methods:

POST

If the current deployment operation has failed, this method may return zero or more exception(s) which represent the errors for this target. The array will not contain WLS exception classes; instead they will be new RuntimeExceptions containing the stack traces and messages from the original WLS Exceptions.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

target

the target where exceptions might have occurred.

Type: string

Response Body

Contains a JSON object with a array of java.lang.Throwable return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/distribute

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Distribute an application.

The application source files and deployment plan are distributed to the deployment targets using the default options. This is a synchronous operation that returns when the distribute operation has completed.

The default options are:

  • clusterDeploymentTimeout: 3600000 milliseconds

  • gracefulIgnoreSessions: false

  • gracefulProductionToAdmin: false

  • retireGracefully: true

  • retireTimeout: no timeout

  • adminMode: false,

  • timeout: no timeout

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

A supported Java EE application or module archive, or a root directory for the application or module.

Type: string

plan

The deployment plan for this application. May be null.

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Distribute an application. The application source files and deployment plan are distributed to the deployment targets using the options specified. This is an asynchronous operation that returns immediately.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The name of the application

Type: string

applicationPath

A supported Java EE application or module archive, or a root directory for the application or module.

Type: string

targets

The targets on which to deploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be distributed on all configured targets.

Type: array of string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes

This resource manages a collection of weblogic.management.runtime.LibDeploymentRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.LibDeploymentRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.LibDeploymentRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}

This resource manages a weblogic.management.runtime.LibDeploymentRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.LibDeploymentRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.LibDeploymentRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}/redeploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Redeploy the library in the background for the targets specified with the options specified. This is an synchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to redeploy the library. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the library will be redeployed on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The keys,units and default values for options are adminMode boolean false, timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Redeploy the library using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are adminMode: false, timeout: no timeout

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/libDeploymentRuntimes/{name}/undeploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Undeploy the library using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are adminMode boolean false timeout: no timeout

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Undeploy the library in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

targets

The targets on which to undeploy the library. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the library will be undeployed on all configured targets.

Type: array of string

deploymentOptions

Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are adminMode boolean false timeout milliseconds 0 (no timeout)

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/purgeCompletedDeploymentProgressObjects

The resource supports the following methods:

POST

Removes progress objects for completed operations.

Roles

Admin, Deployer

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/redeploy

The resource supports the following methods:

POST

Redeploy the application that is deployed to a resource group template in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

Note that this API is only for redeploying applications or libraries that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for redeploying applications that are not deployed to a resource group template, and LibDeploymentRuntimeMBean should be used for redeploying libraries that are not deployed to a resource group template.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout) resourceGroupTemplate this value is required

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/undeploy

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Undeploy the application that is deployed to a resource group template using the default options. This is a synchronous operation that returns when the undeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

template

The resource group template

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

POST

Undeploy the application that is deployed to a resource group template in the background with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.

Note that this API is only for undeploying applications that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for undeploying applications that are not deployed to a resource group template.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

deploymentOptions

Allows for overriding the deployment options. The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout) resourceGroupTemplate this value is required

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/update

The resource supports the following methods:

POST

Allows for updating an application configuration using an changed deployment plan for applications deployed to a resource group template.

A configuration update is equivalent to replacing the application's deployment plan. The deployment plan is redeployed in-place. A new version of the application is not started, even if the new deployment plan has a different version.

The update succeeds only if changes to the deployment plan do not require the application to be restarted. Configuration changes in the new deployment plan must be limited to tuning the application. Changes to resource bindings causes the update to fail. Use redeploy(String, String, Properties) to apply resource binding changes to a production application.

This method targets only root modules. Module level targeting is not supported.

Note that this API is only for updating applications that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for updating applications that are not deployed to a resource group template.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

name

The application name

Type: string

plan

The deployment plan for this application. May be null.

Type: string

deploymentOptions

Allows for overriding the deployment options. The keys, units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout) resourceGroupTemplate this value is required

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.DeploymentProgressObjectMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager

This resource manages a weblogic.management.runtime.EditSessionConfigurationManagerMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.EditSessionConfigurationManagerMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.EditSessionConfigurationManagerMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations

This resource manages a collection of weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entities.

This method can return the following links:

POST

Add a new weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance to this collection.

Roles

Admin, Deployer

Request Body

Must contain a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entity.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations/{name}

This resource manages a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.

The resource supports the following methods:

DELETE

Delete this weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.

Roles

Admin, Deployer

GET

Get this weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/editSessionConfigurations/{name}/containsUnactivatedChanges

The resource supports the following methods:

POST

Returns true if there are changes saved in the pending directory or there are changes in memory. To apply these changes, activate the session.

Roles

Admin, Deployer

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/editSessionConfigurationManager/forceDestroyEditSessionConfiguration

The resource supports the following methods:

POST

Destroys an existing named edit session configuration. This will destroy the associated edit session specific MBeanServer and remove the <domain>/edit/<name> or <domain>/partitions/<name>/edit/<name> directory and subdirectories.

Unlike destroyEditSessionConfiguration(EditSessionConfigurationRuntimeMBean), this operation does not end with error in case that session contains unactivated changes, and allows to destroy even edit sessions not owned by the caller (requires admin privileges).

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

editSession

Edit session to destroy.

Type: weblogic.management.runtime.EditSessionConfigurationRuntimeMBean reference

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime

This resource manages a weblogic.management.runtime.PartitionLifeCycleRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.PartitionLifeCycleRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.PartitionLifeCycleRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceShutdown

The resource supports the following methods:

POST

The resource supports the following methods:

POST

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

timeout

Type: int

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Forces the shutdown of the partition.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Forces the shutdown of the partition on specified targets.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/forceSuspend

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Forcefully suspends the partition.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Forcefully suspends the partition on specified targets.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/getState

The resource supports the following methods:

POST

Get the state of partition on a specific server.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

serverMBean

serverMBean

Type: weblogic.management.configuration.ServerMBean reference

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/purgeTasks

The resource supports the following methods:

POST

Clears the retained task collection.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes

This resource manages a collection of weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}

This resource manages a weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/forceShutdown

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Forces the shutdown of the resource group on specified targets.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Forces the shutdown of the resource group.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/forceSuspend

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Forcefully suspends the resource group on specified targets.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Forcefully suspends the resource group.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/getState

The resource supports the following methods:

POST

Get the state of resource group on a specific server.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

serverMBean

serverMBean

Type: weblogic.management.configuration.ServerMBean reference

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/purgeTasks

The resource supports the following methods:

POST

Clears the retained task collection.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/resume

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Transitions the resource group from ADMIN to RUNNING state on specified targets.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Transitions the resource group from ADMIN to RUNNING state.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Shuts down the resource group gracefully. (equivalent to shutdown(targets, 0, false)).

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down the resource group gracefully on all targets.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully shuts down a resource group.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: int

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

targets

the specific targets on which to shut down this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully shuts down a resource group.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: int

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down a resource group gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: int

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down a resource group gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: int

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

targets

the specific targets on which to shut down this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/start

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Starts resource group.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Starts the resource group on specified targets.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/startInAdmin

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Starts the resource group in the admin state in specified targets

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group in "admin" state

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Starts the resource group in the admin state in all the targets

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Transitions the resource group from RUNNING to ADMIN state gracefully on specified targets.

Applications are in admin mode. Inflight work is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.

Type: int

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully suspends the resource group to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully suspends the resource group to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Transitions the resource group from RUNNING to ADMIN state gracefully.

Applications are in admin mode. Inflight work is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.

Type: int

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks

This resource manages a collection of weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}

This resource manages a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resume

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Transitions the partition from ADMIN to RUNNING state.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Transitions the partition from ADMIN to RUNNING state on specified targets..

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/shutdown

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Shuts down the partition gracefully. (equivalent to shutdown(targets, 0, false)).

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully shuts down a partition.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: int

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

targets

the specific targets on which to shut down this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully shuts down a partition.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: int

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down a partition gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: int

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

targets

the specific targets on which to shut down this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down the partition gracefully on all targets.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down a partition gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: int

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/start

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Starts partition.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Starts the partition in initalState within the specified timeOut

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

initialState

can be can be ADMIN or RUNNING, Default is RUNNING

Type: string

timeOut

Specifies the number of milliseconds to start a Partition. Throws InterruptedException if Partition is unable to start during that duration and leaves the Partition in UNKNOWN state. Default is 60000ms

Type: int

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Starts the partition on specified targets.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/startInAdmin

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Starts the partition in the admin state.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Starts the partition in the admin state.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this partition in "admin" state

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/suspend

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Transitions the partition from RUNNING to ADMIN state gracefully on specified targets.

Applications are in admin mode. Inflight work is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the partition to transition gracefully. The partition automatically calls forceSuspend() after timeout.

Type: int

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

targets

the specific targets on which to start this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully suspends the partition to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Transitions the partition from RUNNING to ADMIN state gracefully.

Applications are in admin mode. Inflight work is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the partition to transition gracefully. The partition automatically calls forceSuspend() after timeout.

Type: int

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully suspends the partition to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this partition

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks

This resource manages a collection of weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}

This resource manages a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager

This resource manages a weblogic.management.runtime.EditSessionConfigurationManagerMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.EditSessionConfigurationManagerMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.EditSessionConfigurationManagerMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations

This resource manages a collection of weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entities.

This method can return the following links:

POST

Add a new weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance to this collection.

Roles

Admin, Deployer

Request Body

Must contain a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entity.

/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}

This resource manages a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.

The resource supports the following methods:

DELETE

Delete this weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.

Roles

Admin, Deployer

GET

Get this weblogic.management.runtime.EditSessionConfigurationRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.EditSessionConfigurationRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/editSessionConfigurations/{name}/containsUnactivatedChanges

The resource supports the following methods:

POST

Returns true if there are changes saved in the pending directory or there are changes in memory. To apply these changes, activate the session.

Roles

Admin, Deployer

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager/forceDestroyEditSessionConfiguration

The resource supports the following methods:

POST

Destroys an existing named edit session configuration. This will destroy the associated edit session specific MBeanServer and remove the <domain>/edit/<name> or <domain>/partitions/<name>/edit/<name> directory and subdirectories.

Unlike destroyEditSessionConfiguration(EditSessionConfigurationRuntimeMBean), this operation does not end with error in case that session contains unactivated changes, and allows to destroy even edit sessions not owned by the caller (requires admin privileges).

Roles

Admin, Deployer

Request Body

Must contain a JSON object with the following fields:

editSession

Edit session to destroy.

Type: weblogic.management.runtime.EditSessionConfigurationRuntimeMBean reference

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime

This resource manages a weblogic.management.runtime.ElasticServiceManagerRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.ElasticServiceManagerRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ElasticServiceManagerRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/getScalingTasks

The resource supports the following methods:

POST

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

clusterName

Cluster name

Type: string

size

The number of ScalingTaskRuntimeMBean to return starting with the most recent.

Type: int

Response Body

Contains a JSON object with a array of weblogic.management.runtime.ScalingTaskRuntimeMBean references return field.

/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/purgeScalingTasks

The resource supports the following methods:

POST

Purge scaling tasks for a service which have completed at least "age" seconds ago. Tasks which are currently running will not be purged.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

clusterName

Cluster name

Type: string

age

Age of tasks to be purged in seconds

Type: int

Response Body

Contains a JSON object with a int return field.

/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleDown

The resource supports the following methods:

POST

Perform a scale down operation

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

clusterName

Cluster name

Type: string

scaleFactor

the size by which the service must be scaled up

Type: int

Response Body

Contains a JSON object with a weblogic.management.runtime.ScalingTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime/scaleUp

The resource supports the following methods:

POST

Perform a scale up operation

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

clusterName

Cluster name

Type: string

scaleFactor

the size by which the service must be scaled up

Type: int

Response Body

Contains a JSON object with a weblogic.management.runtime.ScalingTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/forceShutdownPartitionWait

The resource supports the following methods:

POST

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

partitionMBean

partitionMBean

Type: weblogic.management.configuration.PartitionMBean reference

timeout

Specifies the number of milliseconds to stop a Partition. Throws InterruptedException if Partition is unable to stop during that duration and leaves the Partition in UNKNOWN state. Default is 60000ms

Type: int

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/logRuntime

This resource manages a weblogic.management.runtime.LogRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.LogRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.LogRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/logRuntime/ensureLogOpened

The resource supports the following methods:

POST

Ensures that that the output stream to the underlying is opened if it got closed previously due to errors.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/logRuntime/flushLog

The resource supports the following methods:

POST

Flushes the buffer to the log file on disk.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/logRuntime/forceLogRotation

The resource supports the following methods:

POST

Forces the rotation of the underlying log immediately.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime

This resource manages a weblogic.management.runtime.MessageDrivenControlEJBRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.MessageDrivenControlEJBRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.MessageDrivenControlEJBRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/printMDBStatus

The resource supports the following methods:

POST

Prints the MDBStatus for the specific type of MDB

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

ejbName

ejbName

Type: string

applicationName

applicationName

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/resumeMDBs

The resource supports the following methods:

POST

Resumes the specific type of MDB by calling start on the JMS Connection.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

ejbName

ejbName

Type: string

applicationName

applicationName

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime/suspendMDBs

The resource supports the following methods:

POST

Suspends the specific type of MDB by calling stop on the JMS Connection.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

ejbName

ejbName

Type: string

applicationName

applicationName

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime

This resource manages a weblogic.management.runtime.MigratableServiceCoordinatorRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.MigratableServiceCoordinatorRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.MigratableServiceCoordinatorRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrate

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Migrates all services deployed to the migratableTarget to the destination server. This method assumes that the source and the destination server are up and running. Precondition: The migratableTarget must contain at least one server. The destination server must be a member of the migratableTarget's list of candidate servers. If automatic migration mode is disabled, the destination server must not be the currently hosting server (i.e. head of candidate list of the migratableTarget). Postcondition: If automatic migration mode is disabled and if the migration succeeded, the head of the candidate server list in the migratableTarget will be the destination server.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

migratableTarget

- all services targeted to this target are to be migrated to the destination server. THIS MUST BE A CONFIG MBEAN

Type: weblogic.management.configuration.MigratableTargetMBean reference

destination

- the new server where the services deployed to migratableTarget shall be activated

Type: weblogic.management.configuration.ServerMBean reference

Response Body

Contains an empty JSON object.

POST

Migrates all services deployed to the migratableTarget to the destination server. Use this method if either the source or the destination or both are not running. Precondition: The migratableTarget must contain at least one server. The destination server must be a member of the migratableTarget's list of candidate servers. If automatic migration mode is disabled, the destination server must not be the currently hosting server (i.e. head of candidate list of the migratableTarget). Postcondition: If automatic migration mode is disabled and if the migration succeeded, the head of the candidate server list in the migratableTarget will be the destination server.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

migratableTarget

- all services targeted to this target are to be migrated to the destination server. THIS MUST BE A CONFIG MBEAN

Type: weblogic.management.configuration.MigratableTargetMBean reference

destination

- the new server where the services deployed to migratableTarget shall be activated

Type: weblogic.management.configuration.ServerMBean reference

sourceUp

- the currently active server is up and running. If false, the administrator must ensure that the services deployed to migratableTarget are NOT active.

Type: boolean

destinationUp

- the destination server is up and running.

Type: boolean

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateJTA

The resource supports the following methods:

POST

Migrates the JTARecoveryManager deployed to a migratableTarget to the destination server.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

migratableTarget

migratableTarget

Type: weblogic.management.configuration.MigratableTargetMBean reference

destination

destination

Type: weblogic.management.configuration.ServerMBean reference

sourceUp

sourceUp

Type: boolean

destinationUp

destinationUp

Type: boolean

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime/migrateSingleton

The resource supports the following methods:

POST

Migrates the singleton service specified by the SingletonServiceMBean to the destination server. This method assumes that the source and the destination server are up and running. Precondition: The SingletonServiceMBean must contain at least one server. The destination server must be a member of the SingletonServiceMBean's list of candidate servers. If automatic migration mode is disabled, the destination server must not be the currently hosting server (i.e. head of candidate list of the migratableTarget). Postcondition: If automatic migration mode is disabled and if the migration succeeded, the head of the candidate server list in the migratableTarget will be the destination server.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

singletonService

- SingletonService to be migrated to the destination server. THIS MUST BE A CONFIG MBEAN

Type: weblogic.management.configuration.SingletonServiceMBean reference

destination

- the new server where the singleton service shall be activated

Type: weblogic.management.configuration.ServerMBean reference

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/migrationDataRuntimes

This resource manages a collection of weblogic.management.runtime.MigrationDataRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.MigrationDataRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.MigrationDataRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/migrationDataRuntimes/{name}

This resource manages a weblogic.management.runtime.MigrationDataRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.MigrationDataRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.MigrationDataRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes

This resource manages a collection of weblogic.management.runtime.NodeManagerRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.NodeManagerRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.NodeManagerRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes/{name}

This resource manages a weblogic.management.runtime.NodeManagerRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.NodeManagerRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.NodeManagerRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime

This resource manages a weblogic.management.runtime.WseePolicySubjectManagerRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.WseePolicySubjectManagerRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.WseePolicySubjectManagerRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/getPolicyRefStatus

The resource supports the following methods:

POST

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

policySubject

policySubject

Type: string

policyReferenceURI

policyReferenceURI

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/isOWSMAttachable

The resource supports the following methods:

POST

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

policySubject

policySubject

Type: string

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/removePolicyReference

The resource supports the following methods:

POST

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

policySubject

policySubject

Type: string

policyReferenceURI

policyReferenceURI

Type: string

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime/setPolicyRefStatus

The resource supports the following methods:

POST

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

policySubject

policySubject

Type: string

policyReferenceURI

policyReferenceURI

Type: string

enable

enable

Type: boolean

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes

This resource manages a collection of weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}

This resource manages a weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/forceShutdown

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Forces the shutdown of the resource group on specified targets.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Forces the shutdown of the resource group.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/forceSuspend

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Forcefully suspends the resource group on specified targets.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Forcefully suspends the resource group.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/getState

The resource supports the following methods:

POST

Get the state of resource group on a specific server.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

serverMBean

serverMBean

Type: weblogic.management.configuration.ServerMBean reference

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/purgeTasks

The resource supports the following methods:

POST

Clears the retained task collection.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/resume

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Transitions the resource group from ADMIN to RUNNING state on specified targets.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Transitions the resource group from ADMIN to RUNNING state.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Shuts down the resource group gracefully. (equivalent to shutdown(targets, 0, false)).

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down the resource group gracefully on all targets.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully shuts down a resource group.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: int

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

targets

the specific targets on which to shut down this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully shuts down a resource group.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: int

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down a resource group gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: int

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Shuts down a resource group gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and shutting down the server.

Type: int

ignoreSessions

true indicates ignore pending HTTP sessions during inflight work handling.

Type: boolean

targets

the specific targets on which to shut down this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/start

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Starts resource group.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Starts the resource group on specified targets.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/startInAdmin

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Starts the resource group in the admin state in specified targets

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group in "admin" state

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Starts the resource group in the admin state in all the targets

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Transitions the resource group from RUNNING to ADMIN state gracefully on specified targets.

Applications are in admin mode. Inflight work is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.

Type: int

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully suspends the resource group to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Gracefully suspends the resource group to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

targets

the specific targets on which to start this resource group

Type: array of weblogic.management.configuration.TargetMBean references

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

POST

Transitions the resource group from RUNNING to ADMIN state gracefully.

Applications are in admin mode. Inflight work is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.

Type: int

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks

This resource manages a collection of weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}

This resource manages a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/restartSystemResource

The resource supports the following methods:

POST

Restarts a system resource on all nodes to which it is deployed.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

resource

resource

Type: weblogic.management.configuration.SystemResourceMBean reference

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService

This resource manages a weblogic.management.runtime.RolloutServiceRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.RolloutServiceRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.RolloutServiceRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows

This resource manages a collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.WorkflowTaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}

This resource manages a weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.WorkflowTaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/cancel

The resource supports the following methods:

POST

Sets the cancel flag for the workflow. A canceled workflow will stop as soon as possible. If a command implements the CommandCancelInterface, it will be notified when this flag is set, otherwise, the command will either check it periodically, or the workflow will cancel when the current command completes.

The state of a cancelled command will be {@code CANCELED} or {@code REVERT_CANCELED}.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/canResume

The resource supports the following methods:

POST

It is possible to resume (execute or revert) a workflow if it was already executed and is in a FAIL, REVERT_FAIL, CANCELED or REVERT_CANCELED state.

Roles

Admin

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextExecuteStep

The resource supports the following methods:

POST

Get the next step that will be executed if the workflow is eligible to be resumed and the user were to call execute on it.

Roles

Admin

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/showNextRevertStep

The resource supports the following methods:

POST

Get the next step that will be reverted if the workflow is eligible to be resumed and the user were to call revert on it.

Roles

Admin

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/allWorkflows/{name}/waitFor

The resource supports the following methods:

POST

Waits for the process to finish.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/deleteWorkflow

The resource supports the following methods:

POST

Delete workflow data of finished workflow

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

workflowId

is ID of workflow to be deleted - {@code WorkflowTaskRuntimeMBean.getWorkflowId()}

Type: string

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/execScript

The resource supports the following methods:

POST

Run a custom script from the domain/bin/patching directory on the specified Machine.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

machineName

Name of MachineMBean where the NodeManager runs

Type: string

scriptName

Name of script to run

Type: string

timeoutMillis

millis to wait for script exec to complete. Once the specified time has elapsed the script process is halted and the NodeManager returns the error denoting the timeout. Default is 0 where we block until completion.

Type: long

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/executeWorkflow

The resource supports the following methods:

POST

Continue in workflow execution. Can be called only for terminated workflows.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

wfTask

which should be executed - continued. {@code delegate.isStopped()} must be {@code null}

Type: weblogic.management.runtime.WorkflowTaskRuntimeMBean reference

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/getWorkflowTask

The resource supports the following methods:

POST

Returns {@code WorkflowTaskRuntimeMBean} for given id. Progress must NOT be yet deleted and must be started by this service.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

id

of executed workflow

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows

This resource manages a collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.WorkflowTaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}

This resource manages a weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.WorkflowTaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/cancel

The resource supports the following methods:

POST

Sets the cancel flag for the workflow. A canceled workflow will stop as soon as possible. If a command implements the CommandCancelInterface, it will be notified when this flag is set, otherwise, the command will either check it periodically, or the workflow will cancel when the current command completes.

The state of a cancelled command will be {@code CANCELED} or {@code REVERT_CANCELED}.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/canResume

The resource supports the following methods:

POST

It is possible to resume (execute or revert) a workflow if it was already executed and is in a FAIL, REVERT_FAIL, CANCELED or REVERT_CANCELED state.

Roles

Admin

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextExecuteStep

The resource supports the following methods:

POST

Get the next step that will be executed if the workflow is eligible to be resumed and the user were to call execute on it.

Roles

Admin

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/showNextRevertStep

The resource supports the following methods:

POST

Get the next step that will be reverted if the workflow is eligible to be resumed and the user were to call revert on it.

Roles

Admin

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/inactiveWorkflows/{name}/waitFor

The resource supports the following methods:

POST

Waits for the process to finish.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/initializeRolloutOracleHome

The resource supports the following methods:

POST

Creates but does not start a workflow that can be used to update OracleHome. rolloutUpdate(target, [patchedOracleHome, backupOracleHome, isRollback], [options])

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

target

can be the name of a domain, clusters or servers

Type: string

rolloutOracleHome

the location of the new OracleHome to use

Type: string

backupOracleHome

the location where the current OracleHome should be moved

Type: string

isRollback

true if the new OracleHome is a lower patch version than the current one

Type: string

options

comma separated list of <name>=<value> options

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.RolloutTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/restartNodeManager

The resource supports the following methods:

POST

Restart NodeManager. The java based NodeManager process will exit and the startNodeManager script will detect the need to restart and will restart the NodeManager using the same original call path that was used to start the NodeManager. If this call path was using a symbolic link, then the NodeManager will be started from the location of the symbolic link which may have the affect of starting the NodeManager with an updated set of binaries or scripts.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

machineName

Name of MachineMBean where NodeManager runs

Type: string

isAdminServer

true if the affected server is the AdminServer

Type: boolean

timeoutMillis

How long to wait for the client to reconnect to the NodeManager after it restarts. Timeout exceeded will consider the task failed and the NodeManager not reachable. Default is 3 minutes.

Type: long

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/revertWorkflow

The resource supports the following methods:

POST

Reverts workflow execution. Can be called only for terminated workflows.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

wfTask

which should be reverted. {@code delegate.isStopped()} must be {@code null}

Type: weblogic.management.runtime.WorkflowTaskRuntimeMBean reference

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/rollingRestart

The resource supports the following methods:

POST

Creates and starts a workflow that can be used to update restart servers, one at a time. rolloutUpdate(target, [patchedOracleHome, backupOracleHome, isRollback], [javaHome], [applicationProperties], [options])

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

target

can be the name of a domain, clusters or servers

Type: string

options

comma separated list of <name>=<value> options

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/rolloutApplications

The resource supports the following methods:

POST

Creates and starts a workflow that can be used to update Applications. rolloutUpdate(target, [applicationProperties], [options])

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

target

can be the name of a domain, clusters or servers

Type: string

applicationProperties

the path of a formatted text file containing the information needed to upgrade applications

Type: string

options

comma separated list of <name>=<value> options

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/rolloutJavaHome

The resource supports the following methods:

POST

Creates and starts a workflow that can be used to update JavaHome. rolloutUpdate(target, [javaHome], [options])

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

target

can be the name of a domain, clusters or servers

Type: string

javaHome

the path to the new JavaHome directory

Type: string

options

comma separated list of <name>=<value> options

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/rolloutOracleHome

The resource supports the following methods:

POST

Creates and starts a workflow that can be used to update OracleHome. rolloutUpdate(target, [patchedOracleHome, backupOracleHome, isRollback], [options])

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

target

can be the name of a domain, clusters or servers

Type: string

rolloutOracleHome

the location of the new OracleHome to use

Type: string

backupOracleHome

the location where the current OracleHome should be moved

Type: string

isRollback

true if the new OracleHome is a lower patch version than the current one

Type: string

options

comma separated list of <name>=<value> options

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.RolloutTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/rolloutUpdate

The resource supports the following methods:

POST

Creates and starts a workflow that can be used to update OracleHome, JavaHome, Applications, or any combination of those. rolloutUpdate(target, [patchedOracleHome, backupOracleHome, isRollback], [javaHome], [applicationProperties], [options])

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

target

can be the name of a domain, clusters or servers

Type: string

rolloutOracleHome

the location of the new OracleHome to use

Type: string

backupOracleHome

the location where the current OracleHome should be moved

Type: string

isRollback

true if the new OracleHome is a lower patch version than the current one

Type: string

javaHome

the path to the new JavaHome directory

Type: string

applicationProperties

the path of a formatted text file containing the information needed to upgrade applications

Type: string

options

comma separated list of <name>=<value> options

Type: string

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/shutdownServer

The resource supports the following methods:

POST

Shutdowns the named server.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

serverName

Name of the server that needs to be shutdown

Type: string

sessionTimeout

shutdownTimeout Time limit (in seconds) for server to complete a graceful shutdown. The default is 0 indicating no timeout.

Type: int

ignoreSessions

Drop sessions immediately rather than waiting for them to complete or timeout.

Type: boolean

waitForAllSessions

Wait for all sessions (even sessions backed by a server) to complete.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/startServer

The resource supports the following methods:

POST

Starts the managed server (using the new path location).

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

serverName

Name of managed server to be started

Type: string

sessionTimeout

(required for revert) shutdownTimeout Time limit (in seconds) for server to complete a graceful shutdown.

Type: int

ignoreSessions

(required for revert) Drop sessions immediately rather than waiting for them to complete or timeout.

Type: boolean

waitForAllSessions

Wait for all sessions (even sessions backed by a server) to complete.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.WorkflowTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows

This resource manages a collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.WorkflowTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.WorkflowTaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}

This resource manages a weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.WorkflowTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.WorkflowTaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/cancel

The resource supports the following methods:

POST

Sets the cancel flag for the workflow. A canceled workflow will stop as soon as possible. If a command implements the CommandCancelInterface, it will be notified when this flag is set, otherwise, the command will either check it periodically, or the workflow will cancel when the current command completes.

The state of a cancelled command will be {@code CANCELED} or {@code REVERT_CANCELED}.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/canResume

The resource supports the following methods:

POST

It is possible to resume (execute or revert) a workflow if it was already executed and is in a FAIL, REVERT_FAIL, CANCELED or REVERT_CANCELED state.

Roles

Admin

Response Body

Contains a JSON object with a boolean return field.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextExecuteStep

The resource supports the following methods:

POST

Get the next step that will be executed if the workflow is eligible to be resumed and the user were to call execute on it.

Roles

Admin

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/showNextRevertStep

The resource supports the following methods:

POST

Get the next step that will be reverted if the workflow is eligible to be resumed and the user were to call revert on it.

Roles

Admin

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/rolloutService/stoppedWorkflows/{name}/waitFor

The resource supports the following methods:

POST

Waits for the process to finish.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/search

The resource supports the following methods:

POST

Search the domainRuntime tree.

Request Body

The search request body includes the search criteria.

Response Body

The search response includes the results of the search.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes

This resource manages a collection of weblogic.management.runtime.ServerLifeCycleRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.ServerLifeCycleRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.ServerLifeCycleRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}

This resource manages a weblogic.management.runtime.ServerLifeCycleRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.ServerLifeCycleRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ServerLifeCycleRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceShutdown

The resource supports the following methods:

POST

Immediately transitions a server to the SHUTDOWN state. The server immediately terminates all current work, moves through the SHUTTING_DOWN state, and ends in the SHUTDOWN state.

You can forcefully shut down a server from any state except UNKNOWN

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the forceShutdown Action

This example uses the POST method to synchronously invoke the forceShutdown action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/forceShutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_15_forceShutdown"
    }],
    "progress": "success",
    "serverName": "Cluster-0-Server-1",
    "operation": "forceShutdown",
    "taskStatus": "TASK COMPLETED",
    "completed": true
}
Example 2   Asynchronously Invoke the forceShutdown Action

This example uses the POST method to asynchronously invoke the forceShutdown action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/forceShutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_23_forceShutdown

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_23_forceShutdown"
    }],
    "progress": "processing",
    "serverName": "Cluster-0-Server-1",
    "operation": "forceShutdown",
    "taskStatus": "TASK IN PROGRESS",
    "completed": false
}

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceSuspend

The resource supports the following methods:

POST

Transitions the server from RUNNING to ADMIN state forcefully cancelling inflight work.

Work that cannot be cancelled is dropped. Applications are brought into the admin mode forcefully.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the forceSuspend Action

This example uses the POST method to synchronously invoke the forceSuspend action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/forceSuspend?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_8_forceSuspend"
    }],
    "progress": "success",
    "serverName": "Cluster-0-Server-1",
    "operation": "forceSuspend",
    "taskStatus": "TASK COMPLETED",
    "completed": true
}
Example 2   Asynchronously Invoke the forceSuspend Action

This example uses the POST method to asynchronously invoke the forceSuspend action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/forceSuspend?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_20_forceSuspend"
    }],
    "progress": "success",
    "serverName": "Cluster-0-Server-1",
    "operation": "forceSuspend",
    "taskStatus": "TASK COMPLETED",
    "completed": true
}

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv4URL

The resource supports the following methods:

POST

The IPv4 URL that clients use when connecting to this server using the specified protocol.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

protocol

the desired protocol

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv6URL

The resource supports the following methods:

POST

The IPv6 URL that clients use when connecting to this server using the specified protocol.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

protocol

the desired protocol

Type: string

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/resume

The resource supports the following methods:

POST

Transitions the server from ADMIN to RUNNING state.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the resume Action

This example uses the POST method to synchronously invoke the resume action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/resume?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_6_resume"
    }],
    "progress": "success",
    "serverName": "Cluster-0-Server-1",
    "operation": "resume",
    "taskStatus": "TASK COMPLETED",
    "completed": true
}
Example 2   Asynchronously Invoke the resume Action

This example uses the POST method to asynchronously invoke the resume action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/resume?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_18_resume

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_18_resume"
    }],
    "progress": "processing",
    "serverName": "Cluster-0-Server-1",
    "operation": "resume",
    "taskStatus": "TASK IN PROGRESS",
    "completed": false
}

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Gracefully transitions a server to the SHUTDOWN state. The server completes all current work before it shuts down.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the shutdown Action

This example uses the POST method to synchronously invoke the shutdown action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/shutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_9_shutdown"
    }],
    "progress": "success",
    "serverName": "Cluster-0-Server-1",
    "operation": "shutdown",
    "taskStatus": "TASK COMPLETED",
    "completed": true
}
Example 2   Asynchronously Invoke the shutdown Action

This example uses the POST method to asynchronously invoke the shutdown action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/shutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_21_shutdown

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_21_shutdown"
    }],
    "progress": "processing",
    "serverName": "Cluster-0-Server-1",
    "operation": "shutdown",
    "taskStatus": "TASK IN PROGRESS",
    "completed": false
}

POST

Gracefully shutdown the server after handling inflight work. The following inflight work is handled :

  • Pending transaction's and TLOG checkpoint

  • Pending HTTP sessions

  • Pending JMS work

  • Pending work in the Work Managers

  • RMI requests with tx context or administrator calls

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: int

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

waitForAllSessions

Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the shutdown Action

This example uses the POST method to synchronously invoke the shutdown action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{ timeout: 20, ignoreSessions: true, waitForAllSessions: true }" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/shutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_13_shutdown"
    }],
    "progress": "success",
    "serverName": "Cluster-0-Server-1",
    "operation": "shutdown",
    "taskStatus": "TASK COMPLETED",
    "completed": true
}
Example 2   Asynchronously Invoke the shutdown Action

This example uses the POST method to asynchronously invoke the shutdown action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{ timeout: 20, ignoreSessions: true, waitForAllSessions: true }" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/shutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_27_shutdown

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_27_shutdown"
    }],
    "progress": "processing",
    "serverName": "Cluster-0-Server-1",
    "operation": "shutdown",
    "taskStatus": "TASK IN PROGRESS",
    "completed": false
}

POST

Gracefully transitions a server to the SHUTDOWN state. The server completes all current work before it shuts down.

This method is the same as calling:

shutdown(timeout, ignoreSessions, false);

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Number of seconds to wait before aborting inflight work and force shutting down the server.

Type: int

ignoreSessions

Set to true to ignore pending HTTP sessions during inflight work handling.

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the shutdown Action

This example uses the POST method to synchronously invoke the shutdown action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{ timeout: 20, ignoreSessions: true }" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/shutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_11_shutdown"
    }],
    "progress": "success",
    "serverName": "Cluster-0-Server-1",
    "operation": "shutdown",
    "taskStatus": "TASK COMPLETED",
    "completed": true
}
Example 2   Asynchronously Invoke the shutdown Action

This example uses the POST method to asynchronously invoke the shutdown action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{ timeout: 20, ignoreSessions: true }" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/shutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_25_shutdown

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_25_shutdown"
    }],
    "progress": "processing",
    "serverName": "Cluster-0-Server-1",
    "operation": "shutdown",
    "taskStatus": "TASK IN PROGRESS",
    "completed": false
}

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/start

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Uses the Node Manager to start a Managed Server.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the start Action

This example uses the POST method to synchronously invoke the start action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/start

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_4_start"
    }],
    "identity": [
        "serverLifeCycleRuntimes",
        "Cluster-0-Server-1",
        "tasks",
        "_4_start"
    ],
    "running": false,
    "systemTask": false,
    "endTimeAsLong": 1439526469180,
    "name": "_4_start",
    "progress": "success",
    "description": "Starting Cluster-0-Server-1 server ...",
    "serverName": "Cluster-0-Server-1",
    "taskError": null,
    "startTimeAsLong": 1439526454241,
    "type": "ServerLifeCycleTaskRuntime",
    "operation": "start",
    "taskStatus": "TASK COMPLETED",
    "parentTask": null,
    "completed": true,
    "intervalToPoll": 1000,
    "startTime": "2015-08-14T00:27:34.241-04",
    "endTime": "2015-08-14T00:27:49.180-04"
}
Example 2   Asynchronously Invoke the start Action

This example uses the POST method to asynchronously invoke the start action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/start?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_16_start

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_16_start"
    }],
    "progress": "processing",
    "serverName": "Cluster-0-Server-1",
    "operation": "start",
    "taskStatus": "TASK IN PROGRESS",
    "completed": false
}

POST

Uses the Node Manager to start a Managed Server on the given machine

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

disableMsiMode:

if true, the server will not start in Managed Server Independence mode

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInAdmin

The resource supports the following methods:

POST

Uses the Node Manager to start a Managed Server and place it in the ADMIN state.

The server transitions through the following states:

SHUTDOWN>SUSPENDING>STANDBYADMIN

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInStandby

The resource supports the following methods:

POST

Uses the Node Manager to start a Managed Server and place it in the STANDBY state.

The server transitions through the following states:

SHUTDOWN>SUSPENDING>STANDBY

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/suspend

The resource supports the following methods:

POST

The resource supports the following methods:

POST

Gracefully suspends server to ADMIN state. New requests are rejected and inflight work is allowed to complete.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the suspend Action

This example uses the POST method to synchronously invoke the suspend action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/suspend?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_5_suspendWithTimeout"
    }],
    "progress": "success",
    "serverName": "Cluster-0-Server-1",
    "operation": "suspendWithTimeout",
    "taskStatus": "TASK COMPLETED",
    "completed": true
}
Example 2   Asynchronously Invoke the suspend Action

This example uses the POST method to asynchronously invoke the suspend action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{}" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/suspend?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_17_suspendWithTimeout

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_17_suspendWithTimeout"
    }],
    "progress": "processing",
    "serverName": "Cluster-0-Server-1",
    "operation": "suspendWithTimeout",
    "taskStatus": "TASK IN PROGRESS",
    "completed": false
}

POST

Transitions the server from RUNNING to ADMIN state gracefully.

Applications are in admin mode. Inflight work is completed.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

timeout

Seconds to wait for server to transition gracefully. The server calls forceSuspend() after timeout.

Type: int

ignoreSessions

drop inflight HTTP sessions during graceful suspend

Type: boolean

Response Body

Contains a JSON object with a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean reference return field.

Example

Example 1   Synchronously Invoke the suspend Action

This example uses the POST method to synchronously invoke the suspend action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{ timeout: 10, ignoreSessions: true }" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/suspend?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_7_suspendWithTimeout"
    }],
    "progress": "success",
    "serverName": "Cluster-0-Server-1",
    "operation": "suspendWithTimeout",
    "taskStatus": "TASK COMPLETED",
    "completed": true
}
Example 2   Asynchronously Invoke the suspend Action

This example uses the POST method to asynchronously invoke the suspend action.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{ timeout: 10, ignoreSessions: true }" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/suspend?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

Example Response

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_19_suspendWithTimeout

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_19_suspendWithTimeout"
    }],
    "progress": "processing",
    "serverName": "Cluster-0-Server-1",
    "operation": "suspendWithTimeout",
    "taskStatus": "TASK IN PROGRESS",
    "completed": false
}

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks

This resource manages a collection of weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean entities.

This method can return the following links:

Example

Example 1   View the weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean Collection

This example uses the GET method to display the weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean instances in this collection.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks?fields=completed,progress,serverName,operation&links=none

Example Response

HTTP/1.1 200 OK

Response Body:
{"items": [
    {
        "progress": "success",
        "serverName": "Cluster-0-Server-1",
        "operation": "start",
        "completed": true
    },
    {
        "progress": "success",
        "serverName": "Cluster-0-Server-1",
        "operation": "shutdown",
        "completed": true
    },
    {
        "progress": "success",
        "serverName": "Cluster-0-Server-1",
        "operation": "start",
        "completed": true
    }
]}

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}

This resource manages a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ServerLifeCycleTaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/serverRuntimes

Monitors all the running servers in the WebLogic Server domain from the administration server. From this resource, you can monitor each managed server.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.ServerRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ServerRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes

This resource manages a collection of weblogic.management.runtime.ServiceMigrationDataRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.ServiceMigrationDataRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.ServiceMigrationDataRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes/{name}

This resource manages a weblogic.management.runtime.ServiceMigrationDataRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.ServiceMigrationDataRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.ServiceMigrationDataRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime

This resource manages a weblogic.management.runtime.SNMPAgentRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.SNMPAgentRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.SNMPAgentRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/invalidateLocalizedKeyCache

The resource supports the following methods:

POST

Immediately invalidates the cached security keys for the specified WebLogic Server user.

An SNMP security key is an encrypted version of an SNMP agent's engine ID and an authentication password or privacy password. WebLogic Server generates one security key for each entry that you create in the SNMP credential map. When a WebLogic Server SNMP agent receives an SNMPv3 request, it compares the key that is in the request with its WebLogic Server keys. If it finds a match, it processes the request. The SNMP agent also encodes these keys in its responses and notifications. (You configure which keys are encoded when you create a trap destination.)

Instead of regenerating the keys for each SNMPv3 communication, WebLogic Server caches the keys. To make sure that the cache contains the latest set of SNMP credentials, WebLogic Server periodically invalidates the cache. After the cache is invalidated, the next time an SNMP agent requests credentials, WebLogic Server regenerates the cache.

Note that making a change to the credential map does not automatically update the cache. Instead, the cache is updated only after it has been invalidated.

Instead of waiting for WebLogic Server to invalidate the cached entry for a key, you can invalidate it immediately.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

username

Name of the user

Type: string

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/outputCustomMBeansMIBModule

The resource supports the following methods:

POST

Returns WebLogic Server's MIB module for custom MBeans as a java.lang.String. You can save the String to a file and then load the file into a MIB browser.

When you register custom MBeans in the WebLogic Server Runtime MBean Server, WebLogic Server adds entries to a runtime MIB module that it maintains for custom MBeans. For each custom MBean type, WebLogic Server adds a table to the MIB module. For each instance of the custom MBean, it adds a table row. While WebLogic Server does not persist the MIB module as a file or other data structure, the OIDs in the module remain constant across server sessions.

Roles

Admin

Response Body

Contains a JSON object with a string return field.

/management/weblogic/{version}/domainRuntime/startPartitionWait

The resource supports the following methods:

POST

Starts the Partition with initialState and within timeOut msec. This is synchronous operation, where the function will not return untill the partition is started or an exception is thrown

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin

Request Body

Must contain a JSON object with the following fields:

partitionMBean

partitionMBean

Type: weblogic.management.configuration.PartitionMBean reference

initialState

can be ADMIN or RUNNING, Default is RUNNING

Type: string

timeOut

Specifies the number of milliseconds to start a Partition. Throws InterruptedException if Partition is unable to start during that duration and leaves the Partition in UNKNOWN state. Default is 60000ms

Type: int

Response Body

Contains a JSON object with a weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes

This resource manages a collection of weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}

This resource manages a weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.SystemComponentLifeCycleRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/shutdown

The resource supports the following methods:

POST

Uses Node Manager to shut down a system component.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

props

properties to use when shutting down this system component. These properties are used by the nodemanager plugin.

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/softRestart

The resource supports the following methods:

POST

Uses Node Manager to signal a system component for softRestart.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

props

properties to use when soft-restarting this system component. These properties are used by the nodemanager plugin.

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/start

The resource supports the following methods:

POST

Uses Node Manager to start a system component.

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header. See About Synchronous and Asynchronous Operations.

Roles

Admin, Operator

Request Body

Must contain a JSON object with the following fields:

props

properties to use when starting this system component. These properties are used by the nodemanager plugin.

Type: java.util.Properties

Response Body

Contains a JSON object with a weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean reference return field.

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks

This resource manages a collection of weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}

This resource manages a weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.SystemComponentLifeCycleTaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin, Operator

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks

This resource manages a collection of weblogic.management.runtime.TaskRuntimeMBean instances.

The resource supports the following methods:

GET

Get this collection of weblogic.management.runtime.TaskRuntimeMBean instances.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a list of weblogic.management.runtime.TaskRuntimeMBean entities.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}

This resource manages a weblogic.management.runtime.TaskRuntimeMBean instance.

The resource supports the following methods:

GET

Get this weblogic.management.runtime.TaskRuntimeMBean instance.

Roles

Admin, Deployer, Monitor, Operator

Response Body

Contains a weblogic.management.runtime.TaskRuntimeMBean entity.

This method can return the following links:

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks/{name}/subTasks/{name}/cancel

The resource supports the following methods:

POST

Attempts to cancel this task.

An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

Roles

Admin

Response Body

Contains an empty JSON object.