Jump to

• Request
• Response

View This SAF Remote Endpoint Runtime

get

/management/weblogic/{version}/serverRuntime/SAFRuntime/agents/{name}/remoteEndpoints/{name}

View this SAF remote endpoint 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 SAF remote endpoint runtime.

This method can return the following links:

• rel=action title=closeCursor uri=/management/weblogic/{version}/serverRuntime/SAFRuntime/agents/{name}/remoteEndpoints/{name}/closeCursor

  This resource's closeCursor action resource.

• rel=action title=expireAll uri=/management/weblogic/{version}/serverRuntime/SAFRuntime/agents/{name}/remoteEndpoints/{name}/expireAll

  This resource's expireAll action resource.

• rel=action title=getCursorEndPosition uri=/management/weblogic/{version}/serverRuntime/SAFRuntime/agents/{name}/remoteEndpoints/{name}/getCursorEndPosition

  This resource's getCursorEndPosition action resource.

• rel=action title=getCursorSize uri=/management/weblogic/{version}/serverRuntime/SAFRuntime/agents/{name}/remoteEndpoints/{name}/getCursorSize

  This resource's getCursorSize action resource.

• rel=action title=getCursorStartPosition uri=/management/weblogic/{version}/serverRuntime/SAFRuntime/agents/{name}/remoteEndpoints/{name}/getCursorStartPosition

  This resource's getCursorStartPosition action resource.

• rel=action title=getMessages uri=/management/weblogic/{version}/serverRuntime/SAFRuntime/agents/{name}/remoteEndpoints/{name}/getMessages

  This resource's getMessages action resource.

• rel=action title=pauseForwarding uri=/management/weblogic/{version}/serverRuntime/SAFRuntime/agents/{name}/remoteEndpoints/{name}/pauseForwarding

  This resource's pauseForwarding action resource.

• rel=action title=pauseIncoming uri=/management/weblogic/{version}/serverRuntime/SAFRuntime/agents/{name}/remoteEndpoints/{name}/pauseIncoming

  This resource's pauseIncoming action resource.

• rel=action title=purge uri=/management/weblogic/{version}/serverRuntime/SAFRuntime/agents/{name}/remoteEndpoints/{name}/purge

  This resource's purge action resource.

• rel=action title=resumeForwarding uri=/management/weblogic/{version}/serverRuntime/SAFRuntime/agents/{name}/remoteEndpoints/{name}/resumeForwarding

  This resource's resumeForwarding action resource.

• rel=action title=resumeIncoming uri=/management/weblogic/{version}/serverRuntime/SAFRuntime/agents/{name}/remoteEndpoints/{name}/resumeIncoming

  This resource's resumeIncoming action resource.

• rel=action title=sort uri=/management/weblogic/{version}/serverRuntime/SAFRuntime/agents/{name}/remoteEndpoints/{name}/sort

  This resource's sort action resource.

Body ()

Root Schema : SAF Remote Endpoint Runtime

Type: object

Show Source

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

  Returns the current number of bytes. This number does not include the pending bytes.

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

  Returns the peak number of bytes since the last reset.

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

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

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

  The number of bytes received since the last reset.

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

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

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

  Specifies the longest time, in seconds, that the remote endpoint has not been available since the last reset.

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

  Specifies the total time, in seconds, that the remote endpoint has not been available since the last reset.

• endpointType(optional): string
  Read Only: true

  Specifies if the remote endpoint is a JMS or Web Services (WSRM) destination. The possible values are: weblogic.management.runtime.SAFConstants.JMS_ENDPOINT or weblogic.management.runtime.SAFConstants.WS_ENDPOINT.

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

  Returns the total number of messages that have failed to be forwarded since the last reset.

• lastException(optional): object Throwable

  Represents errors and exceptions.

• lastTimeConnected(optional): string(date-time)
  Read Only: true

  Specifies the last time that the remote endpoint was connected.

  This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX
• lastTimeFailedToConnect(optional): string(date-time)
  Read Only: true

  Specifies the last time that the remote endpoint failed to be connected.

  This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX
• messagesCurrentCount(optional): integer(int64)
  Read Only: true

  Returns the current number of messages. This number includes the pending messages.

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

  Returns the peak number of messages since the last reset.

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

  Returns the number of pending messages. 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 been forwarded but has not been acknowledged.

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

  The number of messages received since the last reset.

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

  Returns 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
• operationState(optional): string
  Read Only: true

  Specifies the state of the most recent ExireAll operation.

• pausedForForwarding(optional): boolean
  Read Only: true

  Indicates if the remote endpoint is currently not forwarding messages.

• pausedForIncoming(optional): boolean
  Read Only: true

  Indicates if a remote endpoint is currently not accepting new messages.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

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

  Specifies the longest time, in seconds, that the remote endpoint has been available since the last reset.

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

  Specifies the total time, in seconds, that the remote endpoint has been available since the last reset.

• URL(optional): string
  Read Only: true

  The URL of the remote endpoint.

{
    "type":"object",
    "properties":{
        "URL":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The URL of the remote endpoint.</p>"
        },
        "bytesCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the current number of bytes. This number does not include the pending bytes.</p>"
        },
        "bytesHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the peak number of bytes since the last reset.</p>"
        },
        "bytesPendingCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the number of pending bytes. 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 since the last reset.</p>"
        },
        "bytesThresholdTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the amount of time in the threshold condition since the last reset.</p>"
        },
        "downtimeHigh":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Specifies the longest time, in seconds, that the remote endpoint has not been available since the last reset.</p>"
        },
        "downtimeTotal":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Specifies the total time, in seconds, that the remote endpoint has not been available since the last reset.</p>"
        },
        "endpointType":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Specifies if the remote endpoint is a JMS or Web Services (WSRM) destination. The possible values are: weblogic.management.runtime.SAFConstants.JMS_ENDPOINT or weblogic.management.runtime.SAFConstants.WS_ENDPOINT.</p>"
        },
        "failedMessagesTotal":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the total number of messages that have failed to be forwarded since the last reset.</p>"
        },
        "lastException":{
            "readOnly":true,
            "$ref":"#/definitions/Throwable"
        },
        "lastTimeConnected":{
            "readOnly":true,
            "type":"string",
            "format":"date-time",
            "description":"<p>Specifies the last time that the remote endpoint was connected.</p> This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
        },
        "lastTimeFailedToConnect":{
            "readOnly":true,
            "type":"string",
            "format":"date-time",
            "description":"<p>Specifies the last time that the remote endpoint failed to be connected.</p> This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
        },
        "messagesCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the current number of messages. This number includes the pending messages.</p>"
        },
        "messagesHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the peak number of messages since the last reset.</p>"
        },
        "messagesPendingCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the number of pending messages. 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 been forwarded but has not been acknowledged.</p>"
        },
        "messagesReceivedCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of messages received since the last reset.</p>"
        },
        "messagesThresholdTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns 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>"
        },
        "operationState":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Specifies the state of the most recent <code>ExireAll</code> operation.</p>"
        },
        "pausedForForwarding":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates if the remote endpoint is currently not forwarding messages.</p>"
        },
        "pausedForIncoming":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates if a remote endpoint is currently not accepting new messages.</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>"
        },
        "uptimeHigh":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Specifies the longest time, in seconds, that the remote endpoint has been available since the last reset.</p>"
        },
        "uptimeTotal":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Specifies the total time, in seconds, that the remote endpoint has been available since the last reset.</p>"
        }
    },
    "description":""
}

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>"
}

Back to Top