RESTful Server Runtime Management Interface for Oracle WebLogic Server

Suspend

post

/management/weblogic/{version}/serverRuntime/JDBCServiceRuntime/JDBCDataSourceRuntimeMBeans/{name}/asyncSuspend

Asynchronously, gracefully suspends a data source that has the health state of Running and disables existing connections. This operation immediately marks the data source as suspended and no further connections are created. Idle (not reserved) connections are marked as disabled. After a timeout period for the suspend operation, all remaining connections in the pool are marked as suspended and the following exception is thrown for any operations on the connection, indicating that the data source is suspended: java.sql.SQLRecoverableException: Connection has been administratively disabled. Try later. These connections remain in the pool and are not closed because the pool may be resumed.

Setting IgnoreInUseConnectionsEnabled to false causes the operation to fail if in-use connections exist.

If successful, the health state is set to Suspended

This is a privileged operation that can only be invoked by an authorized user.

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

name(required): string

The name property of the instance in the collection.
version(required): string

The version of the WebLogic REST interface.

Header Parameters

Prefer: string

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.
X-Requested-By(required): string

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

Must contain the following fields:

Root Schema : Arguments

Type: object

Title: Arguments

Show Source

operationSecs: integer(int32)

The number of seconds to allow the operation to run before stopping processing. If set to 0, the default is used. The default is to use Inactive Connection Timeout Seconds if set or 60 seconds. If you want a minimal timeout, set the value to 1. If you want no timeout, set it to a large value (not recommended).

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "operationSecs":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of seconds to allow the operation to run before stopping processing.  If set to 0, the default is used. The default is to use Inactive Connection Timeout Seconds if set or 60 seconds.  If you want a minimal timeout, set the value to 1. If you want no timeout, set it to a large value (not recommended).</p>"
        }
    },
    "description":""
}

Security

Admin: basic

Type: basic

Description: A user in the Admin security role.

Response

Supported Media Types

application/json

200 Response

Returns the following fields:

Root Schema : Return

Type: object

Title: Return

Show Source

return: array JDBC Data Source Task Runtime Reference

Title: JDBC Data Source Task Runtime Reference

Contains the JDBC data source task runtime reference.
Returns the action's result.

{
    "type":"object",
    "title":"Return",
    "properties":{
        "return":{
            "title":"JDBC Data Source Task Runtime Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the JDBC data source task runtime reference. <p>Returns the action's result.</p>"
        }
    },
    "description":""
}

Nested Schema : JDBC Data Source Task Runtime Reference

Type: array

Title: JDBC Data Source Task Runtime Reference

Contains the JDBC data source task runtime reference.

Returns the action's result.

Show Source

Array of: string

{
    "title":"JDBC Data Source Task Runtime Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the JDBC data source task runtime reference. <p>Returns the action's result.</p>"
}