RESTful Server Runtime Management Interface for Oracle WebLogic Server

View This Connector Connection Pool Runtime

get

/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/inactiveRAs/{name}/connectionPools/{name}

View this connector connection pool runtime.

Request

Path Parameters

name: string

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

The version of the WebLogic REST interface.

Query Parameters

excludeFields(optional): string

The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
excludeLinks(optional): string

The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
fields(optional): string

The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
links(optional): string

The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.

Security

Admin: basic

Type: basic

Description: A user in the Admin security role.
Deployer: basic

Type: basic

Description: A user in the Deployer security role.
Monitor: basic

Type: basic

Description: A user in the Monitor security role.
Operator: basic

Type: basic

Description: A user in the Operator security role.

Response

Supported Media Types

application/json

200 Response

Returns this connector connection pool runtime.

This method can return the following links:

rel=action title=ensureLogOpened uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/inactiveRAs/{name}/connectionPools/{name}/ensureLogOpened
This resource's ensureLogOpened action resource.
rel=action title=flushLog uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/inactiveRAs/{name}/connectionPools/{name}/flushLog
This resource's flushLog action resource.
rel=action title=forceLogRotation uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/inactiveRAs/{name}/connectionPools/{name}/forceLogRotation
This resource's forceLogRotation action resource.
rel=action title=forceReset uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/inactiveRAs/{name}/connectionPools/{name}/forceReset
This resource's forceReset action resource.
rel=action title=reset uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/inactiveRAs/{name}/connectionPools/{name}/reset
This resource's reset action resource.
rel=action title=testPool uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/inactiveRAs/{name}/connectionPools/{name}/testPool
This resource's testPool action resource.
rel=connections uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/inactiveRAs/{name}/connectionPools/{name}/connections
This resource's connections collection resource.
rel=logRuntime uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/inactiveRAs/{name}/connectionPools/{name}/logRuntime
This resource's logRuntime singleton resource.

Root Schema : Connector Connection Pool Runtime

Type: object

Show Source

activeConnectionsCurrentCount(optional): integer(int32)

Read Only: true

The current total active connections.
activeConnectionsHighCount(optional): integer(int32)

Read Only: true

The high water mark of active connections in this Connector Pool since the pool was instantiated.
averageActiveUsage(optional): integer(int32)

Read Only: true

The running average usage of created connections that are active in the Connector Pool since the pool was last shrunk.
capacityIncrement(optional): integer(int32)

Read Only: true

The initial capacity configured for this Connector connection pool.
closeCount(optional): integer(int64)

Read Only: true

The number of connections that were closed for the connection pool.
connectionFactoryClassName(optional): string
Read Only: true
The ConnectionFactoryName of this Connector connection pool.
Constraints
- unharvestable
connectionFactoryName(optional): string
Read Only: true
For 1.0 link-ref resource adapters only, the base resource adapter's connection factory name.
Constraints
- unharvestable
connectionsCreatedTotalCount(optional): integer(int32)

Read Only: true

The total number of Connector connections created in this Connector Pool since the pool is instantiated.
connectionsDestroyedByErrorTotalCount(optional): integer(int32)

Read Only: true

Return the number of connections that were destroyed because an error event was received.
connectionsDestroyedByShrinkingTotalCount(optional): integer(int32)

Read Only: true

Return the number of connections that were destroyed as a result of shrinking.
connectionsDestroyedTotalCount(optional): integer(int32)

Read Only: true

The total number of Connector connections destroyed in this Connector Pool since the pool is instantiated.
connectionsMatchedTotalCount(optional): integer(int32)

Read Only: true

The total number of times a request for a Connector connections was satisfied via the use of an existing created connection since the pool is instantiated.
connectionsRejectedTotalCount(optional): integer(int32)

Read Only: true

The total number of rejected requests for a Connector connections in this Connector Pool since the pool is instantiated.
connectorEisType(optional): string
Read Only: true
The EIS type of this Connector connection pool.
Constraints
- unharvestable
currentCapacity(optional): integer(int64)

Read Only: true

The PoolSize of this Connector connection pool.
EISResourceId(optional): string
Read Only: true
The EISResourceId of this Connector connection pool.
Constraints
- unharvestable
freeConnectionsCurrentCount(optional): integer(int32)

Read Only: true

The current total free connections.
freeConnectionsHighCount(optional): integer(int32)

Read Only: true

The high water mark of free connections in this Connector Pool since the pool was instantiated.
freePoolSizeHighWaterMark(optional): integer(int64)

Read Only: true

The FreePoolSizeHighWaterMark of this Connector connection pool.
freePoolSizeLowWaterMark(optional): integer(int64)

Read Only: true

The FreePoolSizeLowWaterMark of this Connector connection pool.
healthState(optional): object Health State

Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.
highestNumWaiters(optional): integer(int64)

Read Only: true

Gets the highest number of waiters.
initialCapacity(optional): integer(int32)

Read Only: true

The initial capacity configured for this Connector connection pool.
key(optional): string
Read Only: true
The configured Key for the Connection Factory using this Connector connection pool.
Constraints
- unharvestable
lastShrinkTime(optional): integer(int64)

Read Only: true

Return the last time that the pool was shrunk.
logFileName(optional): string
Read Only: true
The Log File used by the Resource Adapter for this Connector connection pool.
Constraints
- unharvestable
logFileStreamOpened(optional): boolean

Read Only: true

Gets the opened state of the log file stream represented by this instance.
loggingEnabled(optional): boolean

Read Only: true

Indicates whether logging is enabled for this Connector connection pool.
managedConnectionFactoryClassName(optional): string
Read Only: true
The ManagedConnectionFactoryName of this Connector connection pool.
Constraints
- unharvestable
maxCapacity(optional): integer(int32)

Read Only: true

The maximum capacity configured for this Connector connection pool.
MCFClassName(optional): string
Read Only: true
Get the MCF class name.
Constraints
- unharvestable
name(optional): string
Read Only: true
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Constraints
- unharvestable
numUnavailableCurrentCount(optional): integer(int32)

Read Only: true

Return the number of unavailable connections.
numUnavailableHighCount(optional): integer(int32)

Read Only: true

Return the highest unavailable number of connections at any given time.
numWaiters(optional): integer(int64)

Read Only: true

Gets the current number of waiters.
numWaitersCurrentCount(optional): integer(int32)

Read Only: true

Return the number of waiters.
poolName(optional): string
Read Only: true
The configured Logical Name for the Connection Factory using this Connector connection pool.
Constraints
- unharvestable
poolSizeHighWaterMark(optional): integer(int64)

Read Only: true

The PoolSizeHighWaterMark of this Connector connection pool.
poolSizeLowWaterMark(optional): integer(int64)

Read Only: true

The PoolSizeLowWaterMark of this Connector connection pool.
proxyOn(optional): boolean

Read Only: true

Return a flag indicating if the proxy is on. Returns true if it is.
recycledTotal(optional): integer(int32)

Read Only: true

The total number of Connector connections that have been recycled in this Connector Pool since the pool is instantiated.
runtimeTransactionSupport(optional): string
Read Only: true
The real transaction support level in use at runtime.
Constraints
- unharvestable
shrinkCountDownTime(optional): integer(int32)

Read Only: true

The amount of time left (in minutes) until an attempt to shrink the pool will be made.
shrinkingEnabled(optional): boolean

Read Only: true

Specifies whether shrinking of this Connector connection pool is enabled.
shrinkPeriodMinutes(optional): integer(int32)

Read Only: true

The Shrink Period (in minutes) of this Connector connection pool.
state(optional): string

Read Only: true

Get the state of the pool.
testable(optional): boolean
Read Only: true
This indicates whether the connection pool is testable or not.
Constraints
- unharvestable
transactionSupport(optional): string
Read Only: true
The static transaction support level, either configured in ra.xml or in @Conector annotation, for the Resource Adapter for this Connector connection pool.
Constraints
- unharvestable
type(optional): string
Read Only: true
Returns the type of the MBean.
Constraints
- unharvestable

{
    "type":"object",
    "properties":{
        "EISResourceId":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The EISResourceId of this Connector connection pool.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "MCFClassName":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the MCF class name.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "activeConnectionsCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The current total active connections.</p>"
        },
        "activeConnectionsHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The high water mark of active connections in this Connector Pool since the pool was instantiated.</p>"
        },
        "averageActiveUsage":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The running average usage of created connections that are active in the Connector Pool since the pool was last shrunk.</p>"
        },
        "capacityIncrement":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The initial capacity configured for this Connector connection pool.</p>"
        },
        "closeCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of connections that were closed for the connection pool.</p>"
        },
        "connectionFactoryClassName":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The ConnectionFactoryName of this Connector connection pool.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "connectionFactoryName":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>For 1.0 link-ref resource adapters only, the base resource adapter's connection factory name.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "connectionsCreatedTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The total number of Connector connections created in this Connector Pool since the pool is instantiated.</p>"
        },
        "connectionsDestroyedByErrorTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Return the number of connections that were destroyed because an error event was received.</p>"
        },
        "connectionsDestroyedByShrinkingTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Return the number of connections that were destroyed as a result of shrinking.</p>"
        },
        "connectionsDestroyedTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The total number of Connector connections destroyed in this Connector Pool since the pool is instantiated.</p>"
        },
        "connectionsMatchedTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The total number of times a request for a Connector connections was satisfied via the use of an existing created connection since the pool is instantiated.</p>"
        },
        "connectionsRejectedTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The total number of rejected requests for a Connector connections in this Connector Pool since the pool is instantiated.</p>"
        },
        "connectorEisType":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The EIS type of this Connector connection pool.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "currentCapacity":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The PoolSize of this Connector connection pool.</p>"
        },
        "freeConnectionsCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The current total free connections.</p>"
        },
        "freeConnectionsHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The high water mark of free connections in this Connector Pool since the pool was instantiated.</p>"
        },
        "freePoolSizeHighWaterMark":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The FreePoolSizeHighWaterMark of this Connector connection pool.</p>"
        },
        "freePoolSizeLowWaterMark":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The FreePoolSizeLowWaterMark of this Connector connection pool.</p>"
        },
        "healthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "highestNumWaiters":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Gets the highest number of waiters.</p>"
        },
        "initialCapacity":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The initial capacity configured for this Connector connection pool.</p>"
        },
        "key":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The configured Key for the Connection Factory using this Connector connection pool.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "lastShrinkTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the last time that the pool was shrunk.</p>"
        },
        "logFileName":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The Log File used by the Resource Adapter for this Connector connection pool.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "logFileStreamOpened":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Gets the opened state of the log file stream represented by this instance.</p>"
        },
        "loggingEnabled":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether logging is enabled for this Connector connection pool.</p>"
        },
        "managedConnectionFactoryClassName":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The ManagedConnectionFactoryName of this Connector connection pool.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "maxCapacity":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The maximum capacity configured for this Connector connection pool.</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "numUnavailableCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Return the number of unavailable connections.</p>"
        },
        "numUnavailableHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Return the highest unavailable number of connections at any given time.</p>"
        },
        "numWaiters":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Gets the current number of waiters.</p>"
        },
        "numWaitersCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Return the number of waiters.</p>"
        },
        "poolName":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The configured Logical Name for the Connection Factory using this Connector connection pool.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "poolSizeHighWaterMark":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The PoolSizeHighWaterMark of this Connector connection pool.</p>"
        },
        "poolSizeLowWaterMark":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The PoolSizeLowWaterMark of this Connector connection pool.</p>"
        },
        "proxyOn":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Return a flag indicating if the proxy is on. Returns true if it is.</p>"
        },
        "recycledTotal":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The total number of Connector connections that have been recycled in this Connector Pool since the pool is instantiated.</p>"
        },
        "runtimeTransactionSupport":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The real transaction support level in use at runtime.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "shrinkCountDownTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The amount of time left (in minutes) until an attempt to shrink the pool will be made.</p>"
        },
        "shrinkPeriodMinutes":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The Shrink Period (in minutes) of this Connector connection pool.</p>"
        },
        "shrinkingEnabled":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Specifies whether shrinking of this Connector connection pool is enabled.</p>"
        },
        "state":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Get the state of the pool.</p>"
        },
        "testable":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"boolean",
            "description":"<p>This indicates whether the connection pool is testable or not.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "transactionSupport":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The static transaction support level, either configured in ra.xml or in @Conector annotation, for the Resource Adapter for this Connector connection pool.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        }
    },
    "description":""
}

Nested Schema : Health State

Type: object

Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.

Show Source

partitionName(optional): string

This property indicates the partition name for which the health state is reported.
state(optional): string
This property indicates the reported state as:
- OK - Service is healthy.
- WARN - Service could have problems in the future
- CRITICAL - Something must be done now to prevent service failure
- FAILED - Service has failed and must be restarted
- OVERLOADED - Service is functioning normally but there is too much work in it
- UNKNOWN - Service state cannot be determined
subsystemName(optional): string

This property indicates the service for which the health state is reported.
symptoms(optional): array Items

Title: Items

This property indicates the cause of the reported state.

{
    "type":"object",
    "properties":{
        "partitionName":{
            "type":"string",
            "description":"<p>This property indicates the partition name for which the health state is reported.</p>"
        },
        "state":{
            "type":"string",
            "description":"<p>This property indicates the reported state as:</p><ul><li><p>OK - Service is healthy.</p></li><li><p>WARN -  Service could have problems in the future</p></li><li><p>CRITICAL - Something must be done now to prevent service failure</p></li><li><p>FAILED - Service has failed and must be restarted</p></li><li><p>OVERLOADED -  Service is functioning normally but there is too much work in it</p></li><li><p>UNKNOWN - Service state cannot be determined</p></li></ul>"
        },
        "subsystemName":{
            "type":"string",
            "description":"<p>This property indicates the service for which the health state is reported.</p>"
        },
        "symptoms":{
            "title":"Items",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Symptom"
            },
            "description":"<p>This property indicates the cause of the reported state.</p>"
        }
    },
    "description":"<p>Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.</p>"
}

Nested Schema : Items

Type: array

Title: Items

This property indicates the cause of the reported state.

Show Source

Array of: object Symptom

Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.

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

Nested Schema : Symptom

Type: object

Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.

Show Source

info(optional): string

This property provides additional information about the symptom if available.
instanceId(optional): string

This property represents an identifier for the symptom.
severity(optional): string

This property indicates a low, medium, or high severity level.
type(optional): string

This property represents the cause of the symptom (low memory, network error, stuck threads, and so on).

{
    "type":"object",
    "properties":{
        "info":{
            "type":"string",
            "description":"<p>This property provides additional information about the symptom if available.</p>"
        },
        "instanceId":{
            "type":"string",
            "description":"<p>This property represents an identifier for the symptom.</p>"
        },
        "severity":{
            "type":"string",
            "description":"<p>This property indicates a low, medium, or high severity level.</p>"
        },
        "type":{
            "type":"string",
            "description":"<p>This property represents the cause of the symptom (low memory, network error, stuck threads, and so on).</p>"
        }
    },
    "description":"<p>Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.</p>"
}