Jump to

• Request
• Response

View This JDBC Data Source Runtime Collection

get

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

View this JDBC data source runtime collection.

Request

Path Parameters

• 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns a list of JDBC data source runtime entities.

Body ()

Root Schema : Items

Type: array

Title: Items

Show Source

• Array of: object JDBC Data Source Runtime

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/JDBC Data Source Runtime"
    },
    "description":""
}

Nested Schema : JDBC Data Source Runtime

Type: object

Show Source

• activeConnectionsAverageCount(optional): integer(int32)
  Read Only: true

  Average number of active connections in this instance of the data source.

  Active connections are connections in use by an application. This value is only valid if the resource is configured to allow shrinking.

• activeConnectionsCurrentCount(optional): integer(int32)
  Read Only: true

  The number of connections currently in use by applications.

• activeConnectionsHighCount(optional): integer(int32)
  Read Only: true

  Highest number of active database connections in this instance of the data source since the data source was instantiated.

  Active connections are connections in use by an application.

• commitOutcomeRetryTotalCount(optional): integer(int64)
  Read Only: true

  The cumulative total number of commit outcome query retries conducted before resolving the outcome or exceeding the retry seconds in this data source since the data source was deployed.

• connectionDelayTime(optional): integer(int32)
  Read Only: true

  The average amount of time, in milliseconds, that it takes to create a physical connection to the database.

  The value is calculated as summary of all times to connect divided by the total number of connections.

• connectionsTotalCount(optional): integer(int32)
  Read Only: true

  The cumulative total number of database connections created in this data source since the data source was deployed.

• currCapacity(optional): integer(int32)
  Read Only: true

  The current count of JDBC connections in the connection pool in the data source.

• currCapacityHighCount(optional): integer(int32)
  Read Only: true

  Highest number of database connections available or in use (current capacity) in this instance of the data source since the data source was deployed.

• databaseProductName(optional): string
  Read Only: true

  The product name of the database that this data source is connected to.

• databaseProductVersion(optional): string
  Read Only: true

  The product version of the database that this data source is connected to.

• deploymentState(optional): integer(int32)
  Read Only: true

  The current deployment state of the module.

  A module can be in one and only one of the following states. State can be changed via deployment or administrator console.

  • UNPREPARED. State indicating at this module is neither prepared or active.

  • PREPARED. State indicating at this module of this application is prepared, but not active. The classes have been loaded and the module has been validated.

  • ACTIVATED. State indicating at this module is currently active.

  • NEW. State indicating this module has just been created and is being initialized.

• driverName(optional): string
  Read Only: true

  The product name of the JDBC driver that this data source is configured to use.

• driverVersion(optional): string
  Read Only: true

  The version of the JDBC driver that this data source is configured to use.

• enabled(optional): boolean
  Read Only: true

  Indicates whether the data source is enabled or disabled:

  • true if the data source is enabled.

  • false if the data source is disabled.

• failedRepurposeCount(optional): integer(int64)
  Read Only: true

  The number of repurpose errors that have occurred since the datasource was deployed.

• failedReserveRequestCount(optional): integer(int64)
  Read Only: true

  The cumulative, running count of requests for a connection from this data source that could not be fulfilled.

• failuresToReconnectCount(optional): integer(int32)
  Read Only: true

  The number of times that the data source attempted to refresh a database connection and failed.

  Failures may occur when the database is unavailable or when the network connection to the database is interrupted.

• highestNumAvailable(optional): integer(int32)
  Read Only: true

  Highest number of database connections that were idle and available to be used by an application at any time in this instance of the data source since the data source was deployed.

• highestNumUnavailable(optional): integer(int32)
  Read Only: true

  Highest number of database connections that were in use by applications or being tested by the system in this instance of the data source since the data source was deployed.

• lastTask(optional): array JDBC Data Source Task Runtime Reference
  Title: JDBC Data Source Task Runtime Reference

  Read Only: true

  Contains the JDBC data source task runtime reference.

  Get the last datasource Task

• leakedConnectionCount(optional): integer(int32)
  Read Only: true

  The number of leaked connections. A leaked connection is a connection that was reserved from the data source but was not returned to the data source by calling close()

• moduleId(optional): string
  Read Only: true

  Returns the identifier for this Component. The identifier is unique within the application.

  Typical modules will use the URI for their id. Web Modules will return their context-root since the web-uri may not be unique within an EAR.

  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
• numAvailable(optional): integer(int32)
  Read Only: true

  The number of database connections that are currently idle and available to be used by applications in this instance of the data source.

• numUnavailable(optional): integer(int32)
  Read Only: true

  The number of connections currently in use by applications or being tested in this instance of the data source.

• prepStmtCacheAccessCount(optional): integer(int64)
  Read Only: true

  The cumulative, running count of the number of times that the statement cache was accessed.

• prepStmtCacheAddCount(optional): integer(int64)
  Read Only: true

  The cumulative, running count of the number of statements added to the statement cache.

  Each connection in the connection pool has its own cache of statements. This number is the sum of the number of statements added to the caches for all connections in the connection pool.

• prepStmtCacheCurrentSize(optional): integer(int32)
  Read Only: true

  The number of prepared and callable statements currently cached in the statement cache.

  Each connection in the connection pool has its own cache of statements. This number is the sum of the number of statements in the caches for all connections in the connection pool.

• prepStmtCacheDeleteCount(optional): integer(int64)
  Read Only: true

  The cumulative, running count of statements discarded from the cache.

  Each connection in the connection pool has its own cache of statements. This number is the sum of the number of statements that were discarded from the caches for all connections in the connection pool.

• prepStmtCacheHitCount(optional): integer(int32)
  Read Only: true

  The cumulative, running count of the number of times that statements from the cache were used.

• prepStmtCacheMissCount(optional): integer(int32)
  Read Only: true

  The number of times that a statement request could not be satisfied with a statement from the cache.

• properties(optional): object Properties
  Title: Properties

  Read Only: true

  Additional Properties Allowed: additionalProperties

  The list of properties for a data source that are passed to the JDBC driver when creating database connections.

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

• repurposeCount(optional): integer(int64)
  Read Only: true

  The number of times connections have been repurposed since the datasource was deployed.

• reserveRequestCount(optional): integer(int64)
  Read Only: true

  The cumulative, running count of requests for a connection from this data source.

• resolvedAsCommittedTotalCount(optional): integer(int64)
  Read Only: true

  The cumulative total number of commit outcomes successfully resolved as committed in this data source since the data source was deployed. This does not refer to the number of outcome query retries used to resolve the outcomes.

• resolvedAsNotCommittedTotalCount(optional): integer(int64)
  Read Only: true

  The cumulative total number of commit outcomes successfully resolved as not committed in this data source since the data source was deployed. This does not refer to the number of outcome query retries used to resolve the outcomes.

• state(optional): string
  Read Only: true

  The current state of the data source.

  Possible states are:

  • Running - the data source is enabled (deployed and not Suspended). This is the normal state of the data source. This state includes conditions when the database server is not available and the data source is created (creation retry must be enabled) or when all connections have failed connection tests (on creation, on reserve, or periodic testing).

  • Suspended - the data source has been disabled.

  • Shutdown - the data source is shutdown and all database connections have been closed.

  • Overloaded - all resources in pool are in use.

  • Unknown - the data source state is unknown.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable
• unresolvedTotalCount(optional): integer(int64)
  Read Only: true

  The cumulative total number of commit outcomes unsuccessfully resolved in this data source since the data source was deployed. This does not refer to the number of outcome query retries used to resolve the outcomes.

• versionJDBCDriver(optional): string
  Read Only: true

  The driver class name of the JDBC driver used to create database connections.

• waitingForConnectionCurrentCount(optional): integer(int32)
  Read Only: true

  The number of connection requests waiting for a database connection.

• waitingForConnectionFailureTotal(optional): integer(int64)
  Read Only: true

  The cumulative, running count of requests for a connection from this data source that had to wait before getting a connection and eventually failed to get a connection.

  Waiting connection requests can fail for a variety of reasons, including waiting for longer than the ConnectionReserveTimeoutSeconds.

• waitingForConnectionHighCount(optional): integer(int32)
  Read Only: true

  Highest number of application requests concurrently waiting for a connection from this instance of the data source.

• waitingForConnectionSuccessTotal(optional): integer(int64)
  Read Only: true

  The cumulative, running count of requests for a connection from this data source that had to wait before getting a connection and eventually succeeded in getting a connection.

• waitingForConnectionTotal(optional): integer(int64)
  Read Only: true

  The cumulative, running count of requests for a connection from this data source that had to wait before getting a connection, including those that eventually got a connection and those that did not get a connection.

• waitSecondsHighCount(optional): integer(int32)
  Read Only: true

  The highest number of seconds that an application waited for a connection (the longest connection reserve wait time) from this instance of the connection pool since the connection pool was instantiated.

  This value is updated when a completed getConnection request takes longer to return a connection than any previous request.

{
    "type":"object",
    "properties":{
        "activeConnectionsAverageCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Average number of active connections in this instance of the data source.</p><p>Active connections are connections in use by an application.  This value is only valid if the resource is configured to allow shrinking.</p>"
        },
        "activeConnectionsCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of connections currently in use by applications.</p>"
        },
        "activeConnectionsHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Highest number of active database connections in this instance of the data source since the data source was instantiated. </p><p>Active connections are connections in use by an application.</p>"
        },
        "commitOutcomeRetryTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The cumulative total number of commit outcome query retries conducted before resolving the outcome or exceeding the retry seconds in this data source since the data source was deployed.</p>"
        },
        "connectionDelayTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The average amount of time, in milliseconds, that it takes to create a physical connection to the database.</p><p>The value is calculated as summary of all times to connect divided by the total number of connections.</p>"
        },
        "connectionsTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The cumulative total number of database connections created in this data source since the data source was deployed.</p>"
        },
        "currCapacity":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The current count of JDBC connections in the connection pool in the data source.</p>"
        },
        "currCapacityHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Highest number of database connections available or in use (current capacity) in this instance of the data source since the data source was deployed.</p>"
        },
        "databaseProductName":{
            "readOnly":true,
            "type":"string",
            "description":"<p> The product name of the database that this data source is connected to. </p>"
        },
        "databaseProductVersion":{
            "readOnly":true,
            "type":"string",
            "description":"<p> The product version of the database that this data source is connected to. </p>"
        },
        "deploymentState":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The current deployment state of the module.</p><p>A module can be in one and only one of the following states. State can be changed via deployment or administrator console.</p><ul><li><p>UNPREPARED. State indicating at this  module is neither  prepared or active.</p></li><li><p>PREPARED. State indicating at this module of this application is prepared, but not active. The classes have been loaded and the module has been validated.</p></li><li><p>ACTIVATED. State indicating at this module  is currently active.</p></li><li><p>NEW. State indicating this module has just been created and is being initialized.</p></li></ul>"
        },
        "driverName":{
            "readOnly":true,
            "type":"string",
            "description":"<p> The product name of the JDBC driver that this data source is configured to use. </p>"
        },
        "driverVersion":{
            "readOnly":true,
            "type":"string",
            "description":"<p> The version of the JDBC driver that this data source is configured to use. </p>"
        },
        "enabled":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the data source is enabled or disabled:</p><ul><li><p><code>true</code> if the data source is enabled.</p></li><li><p><code>false</code> if the data source is disabled.</p></li></ul>"
        },
        "failedRepurposeCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of repurpose errors that have occurred since the datasource was deployed.</p>"
        },
        "failedReserveRequestCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The cumulative, running count of requests for a connection from this data source that could not be fulfilled.</p>"
        },
        "failuresToReconnectCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of times that the data source attempted to refresh a database connection and failed.</p><p>Failures may occur when the database is unavailable or when the network connection to the database is interrupted.</p>"
        },
        "highestNumAvailable":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Highest number of database connections that were idle and available to be used by an application at any time in this instance of the data source since the data source was deployed.</p>"
        },
        "highestNumUnavailable":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Highest number of database connections that were in use by applications or being tested by the system in this instance of the data source since the data source was deployed.</p>"
        },
        "lastTask":{
            "readOnly":true,
            "title":"JDBC Data Source Task Runtime Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the JDBC data source task runtime reference. <p>Get the last datasource Task</p>"
        },
        "leakedConnectionCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of leaked connections. A leaked connection is a connection that was reserved from the data source but was not returned to the data source by calling <code>close()</code></p>"
        },
        "moduleId":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the identifier for this Component.  The identifier is unique within the application.</p><p>Typical modules will use the URI for their id.  Web Modules will return their context-root since the web-uri may not be unique within an EAR.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "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>"
        },
        "numAvailable":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of database connections that are currently idle and  available to be used by applications in this instance of the data source.</p>"
        },
        "numUnavailable":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of connections currently in use by applications or being tested in this instance of the data source.</p>"
        },
        "prepStmtCacheAccessCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The cumulative, running count of the number of times that the statement cache was accessed.</p>"
        },
        "prepStmtCacheAddCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The cumulative, running count of the number of statements added to the statement cache.</p><p>Each connection in the connection pool has its own cache of statements. This number is the sum of the number of statements added to the caches for all connections in the connection pool.</p>"
        },
        "prepStmtCacheCurrentSize":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of prepared and callable statements currently cached in the statement cache.</p><p>Each connection in the connection pool has its own cache of statements. This number is the sum of the number of statements in the caches for all connections in the connection pool.</p>"
        },
        "prepStmtCacheDeleteCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The cumulative, running count of statements discarded from the cache.</p><p>Each connection in the connection pool has its own cache of statements. This number is the sum of the number of statements that were discarded from the caches for all connections in the connection pool.</p>"
        },
        "prepStmtCacheHitCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The cumulative, running count of the number of times that statements from the cache were used.</p>"
        },
        "prepStmtCacheMissCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of times that a statement request could not be satisfied with a statement from the cache.</p>"
        },
        "properties":{
            "readOnly":true,
            "type":"object",
            "description":"<p>The list of properties for a data source that are passed to the JDBC driver when creating database connections.</p><p>This is a privileged operation that can only be invoked by an authorized user.</p>",
            "additionalProperties":{
                "type":"string"
            },
            "title":"Properties"
        },
        "repurposeCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of times connections have been repurposed since the datasource was deployed.</p>"
        },
        "reserveRequestCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The cumulative, running count of requests for a connection from this data source.</p>"
        },
        "resolvedAsCommittedTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The cumulative total number of commit outcomes successfully resolved as committed in this data source since the data source was deployed. This does not refer to the number of outcome query retries used to resolve the outcomes.</p>"
        },
        "resolvedAsNotCommittedTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The cumulative total number of commit outcomes successfully resolved as not committed in this data source since the data source was deployed. This does not refer to the number of outcome query retries used to resolve the outcomes.</p>"
        },
        "state":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The current state of the data source.</p><p>Possible states are:</p><ul><li><p><code>Running</code> - the data source is enabled (deployed and not <code>Suspended</code>). This is the normal state of the data source. This state includes conditions when the database server is not available and the data source is created (creation retry must be enabled) or when all connections have failed connection tests (on creation, on reserve, or periodic testing).</p></li><li><p><code>Suspended</code> - the data source has been disabled.</p></li><li><p><code>Shutdown</code> - the data source is shutdown and all database connections have been closed.</p></li><li><p><code>Overloaded</code> - all resources in pool are in use.</p></li><li><p><code>Unknown</code> - the data source state is unknown.</p></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>"
        },
        "unresolvedTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The cumulative total number of commit outcomes unsuccessfully resolved in this data source since the data source was deployed. This does not refer to the number of outcome query retries used to resolve the outcomes.</p>"
        },
        "versionJDBCDriver":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The driver class name of the JDBC driver used to create database connections. </p>"
        },
        "waitSecondsHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The highest number of seconds that an application waited for a connection (the longest connection reserve wait time) from this instance of the connection pool since the connection pool was instantiated.</p><p>This value is updated when a completed <code>getConnection</code> request takes longer to return a connection than any previous request.</p>"
        },
        "waitingForConnectionCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of connection requests waiting for a database connection.</p>"
        },
        "waitingForConnectionFailureTotal":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The cumulative, running count of requests for a connection from this data source that had to wait before getting a connection and eventually failed to get a connection.</p><p>Waiting connection requests can fail for a variety of reasons, including waiting for longer than the ConnectionReserveTimeoutSeconds.</p>"
        },
        "waitingForConnectionHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Highest number of application requests concurrently waiting for a connection from this instance of the data source.</p>"
        },
        "waitingForConnectionSuccessTotal":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The cumulative, running count of requests for a connection from this data source that had to wait before getting a connection and eventually succeeded in getting a connection.</p>"
        },
        "waitingForConnectionTotal":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The cumulative, running count of requests for a connection from this data source that had to wait before getting a connection, including those that eventually got a connection and those that did not get a connection.</p>"
        }
    },
    "description":""
}

Nested Schema : JDBC Data Source Task Runtime Reference

Type: array

Title: JDBC Data Source Task Runtime Reference

Read Only: true

Contains the JDBC data source task runtime reference.

Get the last datasource Task

Show Source

• Array of: string

{
    "readOnly":true,
    "title":"JDBC Data Source Task Runtime Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the JDBC data source task runtime reference. <p>Get the last datasource Task</p>"
}

Nested Schema : Properties

Type: object

Title: Properties

Read Only: true

Additional Properties Allowed

Show Source

• string

{
    "readOnly":true,
    "type":"object",
    "description":"<p>The list of properties for a data source that are passed to the JDBC driver when creating database connections.</p><p>This is a privileged operation that can only be invoked by an authorized user.</p>",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Properties"
}

The list of properties for a data source that are passed to the JDBC driver when creating database connections.

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

Back to Top