Jump to

• Request
• Response

View This JMS Connection Runtime

get

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

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

This method can return the following links:

• rel=action title=destroy uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/connections/{name}/destroy

  This resource's destroy action resource.

• rel=sessions uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/connections/{name}/sessions

  This resource's sessions collection resource.

Body ()

Root Schema : JMS Connection Runtime

Type: object

Show Source

• clientID(optional): string
  Read Only: true

  The client ID for this connection.

• clientIDPolicy(optional): string
  Read Only: true

  The ClientIDPolicy on this connection or durable subscriber.

  Values are:

  • weblogic.management.configuration.JMSConstants.CLIENT_ID_POLICY_RESTRICTED: Only one connection that uses this policy exists in a cluster at any given time for a particular ClientID

  • weblogic.management.configuration.JMSConstants.CLIENT_ID_POLICY_UNRESTRICTED: Connections created using this policy can specify any ClientID, even when other restricted or unrestricted connections already use the same ClientID

• hostAddress(optional): string
  Read Only: true

  The host address of the client JVM as a string.

• name(optional): string
  Read Only: true

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

  Constraints

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

  The current number of sessions for this connection.

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

  The peak number of sessions for this connection since the last reset.

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

  The number of sessions on this connection since the last reset.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "clientID":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The client ID for this connection.</p>"
        },
        "clientIDPolicy":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The ClientIDPolicy on this connection or durable subscriber.</p><p>Values are:</p><ul><li><p><code>weblogic.management.configuration.JMSConstants.CLIENT_ID_POLICY_RESTRICTED</code>: Only one connection that uses this policy exists in a cluster at any given time for a particular <code>ClientID</code></p></li><li><p><code>weblogic.management.configuration.JMSConstants.CLIENT_ID_POLICY_UNRESTRICTED</code>: Connections created using this policy can specify any <code>ClientID</code>, even when other restricted or unrestricted connections already use the same <code>ClientID</code></p></li></ul>"
        },
        "hostAddress":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The host address of the client JVM as a string.</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>"
        },
        "sessionsCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current number of sessions for this connection.</p>"
        },
        "sessionsHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The peak number of sessions for this connection since the last reset.</p>"
        },
        "sessionsTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of sessions on this connection since the last reset.</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":""
}

Back to Top