Jump to

• Request
• Response

View This Message Driven EJB Runtime Collection

get

/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime/activeRAs/{name}/connectorServiceRuntime/inactiveRAs/{name}/inboundConnections/{name}/MDBRuntimes

View this message driven EJB runtime collection.

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns a list of message driven EJB runtime entities.

Body ()

Root Schema : Items

Type: array

Title: Items

Show Source

• Array of: object Message Driven EJB Runtime

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Message Driven EJB Runtime"
    },
    "description":""
}

Nested Schema : Message Driven EJB Runtime

Type: object

Show Source

• connectionStatus(optional): string
  Read Only: true

  Provides the connection status for the Message Driven Bean. ConnectionStatus can be Connected or Reconnecting.

• destination(optional): string
  Read Only: true

  Provides a count of the Message Driven Bean destination

• EJBName(optional): string
  Read Only: true

  Provides the name for this EJB as defined in the javax.ejb.EJB annotation, or the ejb-name when * using the ejb-jar.xml deployment descriptor.

  Constraints

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

• jmsClientID(optional): string
  Read Only: true

  Provides a count of the Message Driven Bean jmsClientID

• JMSConnectionAlive(optional): boolean
  Read Only: true

  Provides information about whether the Message Driven Bean is currently connected to the JMS destination it is mapped to.

  Returns whether the Message Driven Bean is currently connected to the JMS destination it is mapped to.

• lastException(optional): object Throwable

  Represents errors and exceptions.

• lastExceptionAsString(optional): string
  Read Only: true

  Provides the last exception as String this MDB encountered

• MDBStatus(optional): string
  Read Only: true

  Provides the Message Driven Bean status. MDBStatus is used after the MDB is connected to the destination. MDBStatus can be Running or Suspended.

• name(optional): string
  Read Only: true

  The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

  Constraints

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

  Provides a count of the total number of messages processed by this Message Driven Bean.

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

  Provides a count of the total number of times this MDB is suspended by the user or the EJB container.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "EJBName":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Provides the name for this EJB as defined in the javax.ejb.EJB annotation, or the ejb-name when * using the ejb-jar.xml deployment descriptor.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "JMSConnectionAlive":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Provides information about whether the Message Driven Bean is currently connected to the JMS destination it is mapped to.</p><p>Returns whether the Message Driven Bean is currently connected to the JMS destination it is mapped to.</p>"
        },
        "MDBStatus":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Provides the Message Driven Bean status.  MDBStatus is used after the MDB is connected to the destination. MDBStatus can be Running or Suspended.</p>"
        },
        "connectionStatus":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Provides the connection status for the Message Driven Bean. ConnectionStatus can be Connected or Reconnecting.</p>"
        },
        "destination":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Provides a count of the Message Driven Bean destination</p>"
        },
        "healthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "jmsClientID":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Provides a count of the Message Driven Bean jmsClientID</p>"
        },
        "lastException":{
            "readOnly":true,
            "$ref":"#/definitions/Throwable"
        },
        "lastExceptionAsString":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Provides the last exception as String this MDB encountered</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>"
        },
        "processedMessageCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Provides a count of the total number of messages processed by this Message Driven Bean.</p>"
        },
        "suspendCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Provides a count of the total number of times this MDB is suspended by the user or the EJB container.</p>"
        },
        "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 : Throwable

Type: object

Represents errors and exceptions.

Show Source

• cause(optional): object Throwable

  Represents errors and exceptions.

• message(optional): string

  This property contains the reason why the error or exception was thrown.

• state(optional): string

{
    "type":"object",
    "properties":{
        "cause":{
            "$ref":"#/definitions/Throwable"
        },
        "message":{
            "type":"string",
            "description":"<p>This property contains the reason why the error or exception was thrown.</p>"
        },
        "state":{
            "type":"string",
            "description":""
        }
    },
    "description":"<p>Represents errors and exceptions.</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>"
}

Back to Top