RESTful Domain Runtime Management Interface for Oracle WebLogic Server

  1. RESTful Domain Runtime Management Interface for Oracle WebLogic Server
  2. Tasks
  3. Server Life Cycle Runtime
  4. Actions

Suspend ( Timeout, Ignore Sessions )

post

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

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.

Request

Supported Media Types
  • application/json
Path Parameters
Header Parameters
  • The 'Prefer' header parameter can be used to specify the preference on how this method runs. A value of 'respond-async' specifies a preference to submit the request and return immediately without waiting for completion. Alternatively a value of 'wait=#seconds' specifies a preference to wait for #seconds for method completion before returning. If the Prefer header is not specified or invalid, then a 300 second wait will be used.
  • The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.
Body (
  1. Arguments
)

Must contain the following fields:

Root Schema : Arguments
Type: object
Title: Arguments
Show Source
Security
Back to Top

Response

Supported Media Types
  • application/json

200 Response

Returns the following fields:

Body (
  1. Return
)
Root Schema : Return
Type: object
Title: Return
Show Source
Nested Schema : Server Life Cycle Task Runtime Reference
Type: array
Title: Server Life Cycle Task Runtime Reference
Contains the server life cycle task runtime reference.

Returns the action's result.

Show Source
Back to Top

Examples

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
}

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
}
Back to Top