/management/wls/{version}/servers/id/{server-name}/shutdown

This resource performs a graceful shut down on a specific server.

The resource supports the following methods:

POST Method

The POST method shuts down the server identified by the resource URL.

Roles

Administrator, Deployer, Operator

Request Query Parameters

This resource launches a job to shut down the server.

_detached

(Optional) Specifies whether this method runs in detached (background) mode or synchronously. If the __detached=true query parameter is specified (detached invocation), then this method returns immediately after launching the job. Otherwise, it waits for the job to complete, fail, or timeout (synchronous invocation).

force

(Optional) Specifies whether to gracefully shut down the server (false, the default) or force shut down of the server (true).

Response Body

If the method was invoked synchronously and successfully launched the job, the response body includes a ServerJob entity containing the state of the job (completed, failed, or still running in the case of a timeout) as well as a link to the job resource.

This method can return the following links:

  • uri=/wls/jobs/server/{job-id} rel=job title=name

Response Codes

If the method was invoked synchronously and the job successfully completed, the method returns a 200 OK status code. If the job timed out, the method returns a 202 Accepted status code.

If the method was invoked detached and successfully launched the job, the method returns a 202 Accepted status code and a link to the job resource. In this case, the response does not include a ServerJob entity.

Example

Example 1   Shutting Down a Server

This example uses the POST method to shut down a server synchronously.

Example Request

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X POST http://localhost:7001/management/wls/latest/servers/id/Cluster-0-Server-1/shutdown

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "messages": [{
        "message": "Shutdown the server 'Cluster-0-Server-1'.",
        "severity": "SUCCESS"
    }],
    "links": [{
        "rel": "job",
        "uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/server\/id\/Cluster-0-Server-1:_7_shutdown"
    }],
    "item": {
        "operation": "shutdown",
        "status": "completed",
        "beginTime": 1390587036811,
        "endTime": 1390587036940,
        "name": "_7_shutdown",
        "id": "Cluster-0-Server-1:_7_shutdown",
        "type": "server",
        "description": "Shutting down Cluster-0-Server-1 server ...",
        "serverName": "Cluster-0-Server-1"
    }
}
Example 2   Shutting Down a Server Asynchronously

This example uses the POST method to shut down a server in detached mode.

Example Request

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X POST http://localhost:7001/management/wls/latest/servers/id/Cluster-0-Server-1/shutdown?__detached=true

Example Response

HTTP/1.1 202 Accepted

Response Body:
{
    "messages": [{
        "message": "Shutting down the server 'Cluster-0-Server-1'.",
        "severity": "SUCCESS"
    }],
    "links": [{
        "rel": "job",
        "uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/server\/id\/Cluster-0-Server-1:_11_shutdown"
    }]
}