Jump to

• Request
• Response

View This JMS Server Runtime

get

/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}

View this JMS server 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns this JMS server runtime.

This method can return the following links:

• rel=action title=closeCursor uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/closeCursor

  This resource's closeCursor action resource.

• rel=action title=forceCommit uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/forceCommit

  This resource's forceCommit action resource.

• rel=action title=forceRollback uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/forceRollback

  This resource's forceRollback action resource.

• rel=action title=getCursorEndPosition uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/getCursorEndPosition

  This resource's getCursorEndPosition action resource.

• rel=action title=getCursorSize uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/getCursorSize

  This resource's getCursorSize action resource.

• rel=action title=getCursorStartPosition uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/getCursorStartPosition

  This resource's getCursorStartPosition action resource.

• rel=action title=getMessages uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/getMessages

  This resource's getMessages action resource.

• rel=action title=getTransactionStatus uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/getTransactionStatus

  This resource's getTransactionStatus action resource.

• rel=action title=pauseConsumption uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/pauseConsumption

  This resource's pauseConsumption action resource.

• rel=action title=pauseInsertion uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/pauseInsertion

  This resource's pauseInsertion action resource.

• rel=action title=pauseProduction uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/pauseProduction

  This resource's pauseProduction action resource.

• rel=action title=resumeConsumption uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/resumeConsumption

  This resource's resumeConsumption action resource.

• rel=action title=resumeInsertion uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/resumeInsertion

  This resource's resumeInsertion action resource.

• rel=action title=resumeProduction uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/resumeProduction

  This resource's resumeProduction action resource.

• rel=action title=sort uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sort

  This resource's sort action resource.

• rel=destinations uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/destinations

  This resource's destinations collection resource.

• rel=logRuntime uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/logRuntime

  This resource's logRuntime singleton resource.

• rel=sessionPoolRuntimes uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes

  This resource's sessionPoolRuntimes collection resource.

Body ()

Root Schema : JMS Server Runtime

Type: object

Show Source

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

  The current number of bytes stored on this JMS server.

  This number does not include the pending bytes.

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

  The peak number of bytes stored in the JMS server since the last reset.

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

  Return the total number of bytes in all the messages that are currently available to be paged out, but which have not yet been paged out. The JMS server attempts to keep this number smaller than the "MessageBufferSize" parameter.

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

  Return the total number of bytes that were read from the paging directory since the JMS server was started.

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

  Return the total number of bytes that were written to the paging directory since the JMS server was started.

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

  The current number of bytes pending (unacknowledged or uncommitted) stored on this JMS server.

  Pending bytes are over and above the current number of bytes.

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

  The number of bytes received on this JMS server since the last reset.

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

  The amount of time in the threshold condition since the last reset.

• consumptionPaused(optional): boolean
  Read Only: true

  Returns the current consumption paused state of the JMSServer as boolean value.

• consumptionPausedState(optional): string
  Read Only: true

  Returns the current consumption paused state of the JMSServer as string value.

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

  The current number of destinations for this JMS server.

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

  The peak number of destinations on this JMS server since the last reset.

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

  The number of destinations instantiated on this JMS server since the last reset.

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

• insertionPaused(optional): boolean
  Read Only: true

  Returns the current insertion paused state of the JMSServer as boolean value.

• insertionPausedState(optional): string
  Read Only: true

  Returns the current insertion paused state of the JMSServer as string value.

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

  The current number of messages stored on this JMS server. This number does not include the pending messages.

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

  The peak number of messages stored in the JMS server since the last reset.

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

  Return the number of messages that are currently available for paging in this JMS server but have not yet been paged out. Note that due to internal implementation details, this count may be zero even if "PageableByteCurrentCount" is zero.

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

  Return the total number of messages that were read from the paging directory since the JMS server was started.

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

  Return the total number of messages that were written to the paging directory since the JMS server was started.

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

  The current number of messages pending (unacknowledged or uncommitted) stored on this JMS server.

  Pending messages are over and above the current number of messages.

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

  The number of messages received on this destination since the last reset.

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

  The amount of time in the threshold condition since the last reset.

• name(optional): string
  Read Only: true

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

  Constraints

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

  See PersistentStoreRuntimeMBean.AllocatedIoBufferBytes

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

  See PersistentStoreRuntimeMBean.AllocatedWindowBufferBytes

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

  See PersistentStoreRuntimeMBean.PhysicalWriteCount

• pendingTransactions(optional): array Items
  Title: Items

  Read Only: true

  Returns an array of Xids representing transaction branches that exist onthis JMS server in the pending state, i.e. branches that have been prepared by the transaction manager but not yet committed or rolled back.

• productionPaused(optional): boolean
  Read Only: true

  Returns the current production paused state of the JMSServer as boolean value.

• productionPausedState(optional): string
  Read Only: true

  Returns the current production paused state of the JMSServer as string value.

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

  The current number of session pools instantiated on this JMS server.

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

  The peak number of session pools instantiated on this JMS server since the last reset.

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

  The number of session pools instantiated on this JMS server since the last reset.

• transactions(optional): array Items
  Title: Items

  Read Only: true

  Returns an array of Xids representing transaction branches that exist on this JMS server in any state.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "bytesCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current number of bytes stored on this JMS server.</p><p>This number does not include the pending bytes.</p>"
        },
        "bytesHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The peak number of bytes stored in the JMS server since the last reset.</p>"
        },
        "bytesPageableCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the total number of bytes in all the messages that are currently available to be paged out, but which have not yet been paged out. The JMS server attempts to keep this number smaller than the \"MessageBufferSize\" parameter.</p>"
        },
        "bytesPagedInTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the total number of bytes that were read from the paging directory since the JMS server was started.</p>"
        },
        "bytesPagedOutTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the total number of bytes that were written to the paging directory since the JMS server was started.</p>"
        },
        "bytesPendingCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current number of bytes pending (unacknowledged or uncommitted) stored on this JMS server.</p><p>Pending bytes are over and above the current number of bytes.</p>"
        },
        "bytesReceivedCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of bytes received on this JMS server since the last reset.</p>"
        },
        "bytesThresholdTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The amount of time in the threshold condition since the last reset.</p>"
        },
        "consumptionPaused":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Returns the current consumption paused state of the JMSServer as boolean value.</p>"
        },
        "consumptionPausedState":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the current consumption paused state of the JMSServer as string value.</p>"
        },
        "destinationsCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current number of destinations for this JMS server.</p>"
        },
        "destinationsHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The peak number of destinations on this JMS server since the last reset.</p>"
        },
        "destinationsTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of destinations instantiated on this JMS server since the last reset.</p>"
        },
        "healthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "insertionPaused":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Returns the current insertion paused state of the JMSServer as boolean value.</p>"
        },
        "insertionPausedState":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the current insertion paused state of the JMSServer as string value.</p>"
        },
        "messagesCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current number of messages stored on this JMS server. This number does not include the pending messages.</p>"
        },
        "messagesHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The peak number of messages stored in the JMS server since the last reset.</p>"
        },
        "messagesPageableCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Return the number of messages that are currently available for paging in this JMS server but have not yet been paged out. Note that due to internal implementation details, this count may be zero even if \"PageableByteCurrentCount\" is zero.</p>"
        },
        "messagesPagedInTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Return the total number of messages that were read from the paging directory since the JMS server was started.</p>"
        },
        "messagesPagedOutTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Return the total number of messages that were written to the paging directory since the JMS server was started.</p>"
        },
        "messagesPendingCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current number of messages pending (unacknowledged or uncommitted) stored on this JMS server.</p><p>Pending messages are over and above the current number of messages.</p>"
        },
        "messagesReceivedCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of messages received on this destination since the last reset.</p>"
        },
        "messagesThresholdTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The amount of time in the threshold condition since the last reset.</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>"
        },
        "pagingAllocatedIoBufferBytes":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>See PersistentStoreRuntimeMBean.AllocatedIoBufferBytes</p>"
        },
        "pagingAllocatedWindowBufferBytes":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>See PersistentStoreRuntimeMBean.AllocatedWindowBufferBytes</p>"
        },
        "pagingPhysicalWriteCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>See PersistentStoreRuntimeMBean.PhysicalWriteCount</p>"
        },
        "pendingTransactions":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Returns an array of Xids representing transaction branches that exist onthis JMS server in the pending state, i.e. branches that have been prepared by the transaction manager but not yet committed or rolled back.</p>"
        },
        "productionPaused":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Returns the current production paused state of the JMSServer as boolean value.</p>"
        },
        "productionPausedState":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the current production paused state of the JMSServer as string value.</p>"
        },
        "sessionPoolsCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current number of session pools instantiated on this JMS server.</p>"
        },
        "sessionPoolsHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The peak number of session pools instantiated on this JMS server since the last reset.</p>"
        },
        "sessionPoolsTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of session pools instantiated on this JMS server since the last reset.</p>"
        },
        "transactions":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Returns an array of Xids representing transaction branches that exist on this JMS server in any state.</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 : Items

Type: array

Title: Items

Read Only: true

Returns an array of Xids representing transaction branches that exist onthis JMS server in the pending state, i.e. branches that have been prepared by the transaction manager but not yet committed or rolled back.

Show Source

• Array of: string

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Returns an array of Xids representing transaction branches that exist onthis JMS server in the pending state, i.e. branches that have been prepared by the transaction manager but not yet committed or rolled back.</p>"
}

Nested Schema : Items

Type: array

Title: Items

Read Only: true

Returns an array of Xids representing transaction branches that exist on this JMS server in any state.

Show Source

• Array of: string

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Returns an array of Xids representing transaction branches that exist on this JMS server in any state.</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