RESTful Server Runtime Management Interface for Oracle WebLogic Server

View This JMS Destination Runtime

get

/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime

View this JMS destination runtime.

Request

Path Parameters

name(required): string

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

The version of the WebLogic REST interface.

Query Parameters

excludeFields: 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: 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: 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: 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 JMS destination runtime.

This method can return the following links:

rel=action title=createDurableSubscriber uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/createDurableSubscriber
This resource's createDurableSubscriber action resource.
rel=action title=deleteDurableSubscriber uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/deleteDurableSubscriber
This resource's deleteDurableSubscriber action resource.
rel=action title=deleteMessages uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/deleteMessages
This resource's deleteMessages action resource.
rel=action title=exportMessages uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/exportMessages
This resource's exportMessages action resource.
rel=action title=getJMSMessage uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/getJMSMessage
This resource's getJMSMessage action resource.
rel=action title=getJMSMessages uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/getJMSMessages
This resource's getJMSMessages action resource.
rel=action title=getJMSTextMessage uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/getJMSTextMessage
This resource's getJMSTextMessage action resource.
rel=action title=importMessages uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/importMessages
This resource's importMessages action resource.
rel=action title=moveMessages uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/moveMessages
This resource's moveMessages action resource.
rel=action title=pauseConsumption uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/pauseConsumption
This resource's pauseConsumption action resource.
rel=action title=pauseInsertion uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/pauseInsertion
This resource's pauseInsertion action resource.
rel=action title=pauseProduction uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/pauseProduction
This resource's pauseProduction action resource.
rel=action title=produceTextMessage uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/produceTextMessage
This resource's produceTextMessage action resource.
rel=action title=resumeConsumption uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/resumeConsumption
This resource's resumeConsumption action resource.
rel=action title=resumeInsertion uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/resumeInsertion
This resource's resumeInsertion action resource.
rel=action title=resumeProduction uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/resumeProduction
This resource's resumeProduction action resource.
rel=durableSubscribers uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/durableSubscribers
This resource's durableSubscribers collection resource.
rel=tasks uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes/{name}/JMSServer/destinations/{name}/durableSubscribers/{name}/destinationRuntime/tasks
This resource's tasks collection resource.

Root Schema : JMS Destination Runtime

Type: object

Show Source

bytesCurrentCount: integer(int64)

Read Only: true

The current number of bytes stored in the destination. This does not include the pending bytes.
bytesHighCount: integer(int64)

Read Only: true

The peak number of bytes stored in the destination since the last reset.
bytesPendingCount: integer(int64)

Read Only: true

The number of pending bytes stored in the destination.
Pending bytes are over and above the current number of bytes.
bytesReceivedCount: integer(int64)

Read Only: true

The number of bytes received in this destination since the last reset.
bytesThresholdTime: integer(int64)

Read Only: true

The amount of time in the threshold condition since the last reset.
consumersCurrentCount: integer(int64)

Read Only: true

The current number of consumers accessing this destination.
consumersHighCount: integer(int64)

Read Only: true

The peak number of consumers accessing this destination since the last reset.
consumersTotalCount: integer(int64)

Read Only: true

The total number of consumers accessing this destination since the last reset.
consumptionPaused: boolean

Read Only: true

Indicates the consumption Pause state of the destination.
consumptionPausedState: string

Read Only: true

The current consumption pause state of the destination.
destinationID: string

Read Only: true

Returns the destination ID.
destinationType: string

Read Only: true

The destination type, either weblogic.management.configuration.JMSConstants.DESTINATION_TYPE_QUEUE or weblogic.management.configuration.JMSConstants.DESTINATION_TYPE_TOPIC depending upon whether the destination is a queue or topic.
insertionPaused: boolean

Read Only: true

Indicates the InsertionPause state of the destination.
insertionPausedState: string

Read Only: true

The current insertion pause state of the destination.
messagesCurrentCount: integer(int64)

Read Only: true

The current number of messages in the destination. This does not include the pending messages.
messagesDeletedCurrentCount: integer(int64)

Read Only: true

Returns the number of messages that have been deleted from the destination.
messagesHighCount: integer(int64)

Read Only: true

The peak number of messages in the destination since the last reset.
messagesMovedCurrentCount: integer(int64)

Read Only: true

Returns the number of messages that have been moved from the destination.
messagesPendingCount: integer(int64)

Read Only: true

The number of pending messages in the destination.
Pending messages are over and above the current number of messages. A pending message is one that has either been sent in a transaction and not committed, or that has been received and not committed or acknowledged.
messagesReceivedCount: integer(int64)

Read Only: true

The number of messages received in this destination since the last reset.
messagesThresholdTime: integer(int64)

Read Only: true

The amount of time in the threshold condition since the last reset.
name: string
Read Only: true
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Constraints
- unharvestable
productionPaused: boolean

Read Only: true

Indicates the ProductionPause state of the destination.
productionPausedState: string

Read Only: true

The current production pause state of the destination.
state: string

Read Only: true

The operational state of the destination as a String.
subscriptionMessagesLimit: integer(int64)

Read Only: true

The effective messages limit on topic subscriptions (not applicable to queues). A '-1' indicates that no limit is configured or active.
type: 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 in the destination. This does not include the pending bytes.</p>"
        },
        "bytesHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The peak number of bytes stored in the destination since the last reset.</p>"
        },
        "bytesPendingCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of pending bytes stored in the destination.</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 in this destination 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>"
        },
        "consumersCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current number of consumers accessing this destination.</p>"
        },
        "consumersHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The peak number of consumers accessing this destination since the last reset.</p>"
        },
        "consumersTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The total number of consumers accessing this destination since the last reset.</p>"
        },
        "consumptionPaused":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates the consumption Pause state of the destination.</p>"
        },
        "consumptionPausedState":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The current consumption pause state of the destination.</p>"
        },
        "destinationID":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the destination ID.</p>"
        },
        "destinationType":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The destination type, either <code>weblogic.management.configuration.JMSConstants.DESTINATION_TYPE_QUEUE</code> or <code>weblogic.management.configuration.JMSConstants.DESTINATION_TYPE_TOPIC</code> depending upon whether the destination is a queue or topic.</p>"
        },
        "insertionPaused":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates the InsertionPause state of the destination.</p>"
        },
        "insertionPausedState":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The current insertion pause state of the destination.</p>"
        },
        "messagesCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current number of messages in the destination. This does not include the pending messages.</p>"
        },
        "messagesDeletedCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the number of messages that have been deleted from the destination.</p>"
        },
        "messagesHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The peak number of messages in the destination since the last reset.</p>"
        },
        "messagesMovedCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the number of messages that have been moved from the destination.</p>"
        },
        "messagesPendingCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of pending messages in the destination.</p><p>Pending messages are over and above the current number of messages. A pending message is one that has either been sent in a transaction and not committed, or that has been received and not committed or acknowledged.</p>"
        },
        "messagesReceivedCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of messages received in 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>"
        },
        "productionPaused":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates the ProductionPause state of the destination.</p>"
        },
        "productionPausedState":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The current production pause state of the destination.</p>"
        },
        "state":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The operational state of the destination as a String.</p>"
        },
        "subscriptionMessagesLimit":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The effective messages limit on topic subscriptions (not applicable to queues). A '-1' indicates that no limit is configured or active.</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":""
}