Jump to

• Request
• Response

View Proxy Service Information

get

/management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}/proxy

Use this endpoint to view operational and performance statistics for a proxy service on the specified service member. HTTP proxy information is provided if an HTTP Acceptor is configured. The information includes throughput and connection metrics for clients that connect to the cluster using the proxy service.

Request

Path Parameters

• memberIdentifier: string
  An identifier of the member, it can either be the name or the nodeId of the member.
• serviceName: string
  Name of the cache service.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A successful request that returns proxy service information

Body ()

Root Schema : proxyInfo

Type: object

Details of the proxy service

Show Source

• averageRequestTime(optional): number(float)
  Read Only: true

  The average processing time in milliseconds for HTTP requests.
• connectionCount(optional): integer(int32)
  Read Only: true

  The number of client connections.
• hostIP(optional): string
  Read Only: true

  The IP address and port of the Proxy host.
• httpServerType(optional): string
  Read Only: true

  The type of HTTP server or n/a if not using HTTP protocol.
• incomingBufferPoolCapacity(optional): integer(int64)
  Read Only: true

  The pool capacity (in bytes) of the incoming buffer.
• incomingBufferPoolSize(optional): integer(int32)
  Read Only: true

  The number of buffers in the incoming pool.
• location(optional): string
  Read Only: true

  The location of the MBean server
• member(optional): string
  Read Only: true

  Name of the cluster member
• messagingDebug(optional): boolean
  Debug flag. When true and the node's logging level is 6 or higher, sent and received messages will be logged for all the connections under this service.
• nodeId(optional): integer(int64)
  Read Only: true

  The ID of member to which the MBean belongs
• outgoingBufferPoolCapacity(optional): integer(int64)
  Read Only: true

  The pool capacity (in bytes) of the outgoing buffer.
• outgoingBufferPoolSize(optional): integer(int32)
  Read Only: true

  The number of buffers in the outgoing pool.
• outgoingByteBacklog(optional): integer(int64)
  Read Only: true

  The backlog (in bytes) of the outgoing queue
• outgoingMessageBacklog(optional): integer(int64)
  Read Only: true

  The backlog of the outgoing message queue.
• protocol(optional): string
  Read Only: true

  Allowed Values: [ "tcp", "http" ]

  Protocol associated with this ConnectionManagerMBean. Valid values are tcp or http.
• refreshTime(optional): string(date-time)
  Read Only: true

  The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
• requestsPerSecond(optional): number(float)
  Read Only: true

  The number of HTTP requests per second since the statistics were reset.
• responseCount1xx(optional): integer(int64)
  Read Only: true

  The number of HTTP responses in the 100-199 range.
• responseCount2xx(optional): integer(int64)
  Read Only: true

  The number of HTTP responses in the 200-299 range.
• responseCount3xx(optional): integer(int64)
  Read Only: true

  The number of HTTP responses in the 300-399 range.
• responseCount4xx(optional): integer(int64)
  Read Only: true

  The number of HTTP responses in the 400-499 range.
• responseCount5xx(optional): integer(int64)
  Read Only: true

  The number of HTTP responses in the 500-599 range.
• totalBytesReceived(optional): integer(int64)
  Read Only: true

  The total number of bytes received by the Proxy host since the statistics were last reset.
• totalBytesSent(optional): integer(int64)
  Read Only: true

  The total number of bytes sent by the Proxy host since the statistics were last reset.
• totalErrorCount(optional): integer(int64)
  Read Only: true

  The number of HTTP requests that caused errors.
• totalMessagesReceived(optional): integer(int64)
  Read Only: true

  The total number of messages received by the Proxy host since the statistics were last reset.
• totalMessagesSent(optional): integer(int64)
  Read Only: true

  The total number of messages sent by the Proxy host since the statistics were last reset.
• totalRequestCount(optional): integer(int64)
  Read Only: true

  The number of requests serviced since the HTTP server was started or the statistics were reset.
• type(optional): string
  Read Only: true

  Allowed Values: [ "ConnectionManager" ]

  The type of the MBean
• unauthorizedConnectionAttempts(optional): integer(int64)
  Read Only: true

  The number of connection attempts from unauthorized hosts.

{
    "type":"object",
    "description":"Details of the proxy service",
    "properties":{
        "nodeId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of member to which the MBean belongs",
            "readOnly":true
        },
        "location":{
            "type":"string",
            "description":"The location of the MBean server",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "description":"The type of the MBean",
            "enum":[
                "ConnectionManager"
            ],
            "readOnly":true
        },
        "member":{
            "type":"string",
            "description":"Name of the cluster member",
            "readOnly":true
        },
        "protocol":{
            "type":"string",
            "description":"Protocol associated with this ConnectionManagerMBean. Valid values are tcp or http.",
            "readOnly":true,
            "enum":[
                "tcp",
                "http"
            ]
        },
        "hostIP":{
            "type":"string",
            "description":"The IP address and port of the Proxy host.",
            "readOnly":true
        },
        "requestsPerSecond":{
            "type":"number",
            "format":"float",
            "description":"The number of HTTP requests per second since the statistics were reset.",
            "readOnly":true
        },
        "messagingDebug":{
            "type":"boolean",
            "description":"Debug flag.  When true and the node's logging level is 6 or higher, sent and received messages will be logged for all the connections under this service.",
            "readOnly":false
        },
        "incomingBufferPoolCapacity":{
            "type":"integer",
            "format":"int64",
            "description":"The pool capacity (in bytes) of the incoming buffer.",
            "readOnly":true
        },
        "refreshTime":{
            "type":"string",
            "format":"date-time",
            "description":"The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.",
            "readOnly":true
        },
        "connectionCount":{
            "type":"integer",
            "format":"int32",
            "description":"The number of client connections.",
            "readOnly":true
        },
        "averageRequestTime":{
            "type":"number",
            "format":"float",
            "description":"The average processing time in milliseconds for HTTP requests.",
            "readOnly":true
        },
        "outgoingBufferPoolSize":{
            "type":"integer",
            "format":"int32",
            "description":"The number of buffers in the outgoing pool.",
            "readOnly":true
        },
        "unauthorizedConnectionAttempts":{
            "type":"integer",
            "format":"int64",
            "description":"The number of connection attempts from unauthorized hosts.",
            "readOnly":true
        },
        "totalRequestCount":{
            "type":"integer",
            "format":"int64",
            "description":"The number of requests serviced since the HTTP server was started or the statistics were reset.",
            "readOnly":true
        },
        "totalBytesReceived":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of bytes received by the Proxy host since the statistics were last reset.",
            "readOnly":true
        },
        "httpServerType":{
            "type":"string",
            "description":"The type of HTTP server or n/a if not using HTTP protocol.",
            "readOnly":true
        },
        "incomingBufferPoolSize":{
            "type":"integer",
            "format":"int32",
            "description":"The number of buffers in the incoming pool.",
            "readOnly":true
        },
        "totalBytesSent":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of bytes sent by the Proxy host since the statistics were last reset.",
            "readOnly":true
        },
        "totalMessagesSent":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of messages sent by the Proxy host since the statistics were last reset.",
            "readOnly":true
        },
        "responseCount2xx":{
            "type":"integer",
            "format":"int64",
            "description":"The number of HTTP responses in the 200-299 range.",
            "readOnly":true
        },
        "outgoingBufferPoolCapacity":{
            "type":"integer",
            "format":"int64",
            "description":"The pool capacity (in bytes) of the outgoing buffer.",
            "readOnly":true
        },
        "responseCount3xx":{
            "type":"integer",
            "format":"int64",
            "description":"The number of HTTP responses in the 300-399 range.",
            "readOnly":true
        },
        "totalMessagesReceived":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of messages received by the Proxy host since the statistics were last reset.",
            "readOnly":true
        },
        "responseCount4xx":{
            "type":"integer",
            "format":"int64",
            "description":"The number of HTTP responses in the 400-499 range.",
            "readOnly":true
        },
        "responseCount5xx":{
            "type":"integer",
            "format":"int64",
            "description":"The number of HTTP responses in the 500-599 range.",
            "readOnly":true
        },
        "totalErrorCount":{
            "type":"integer",
            "format":"int64",
            "description":"The number of HTTP requests that caused errors.",
            "readOnly":true
        },
        "responseCount1xx":{
            "type":"integer",
            "format":"int64",
            "description":"The number of HTTP responses in the 100-199 range.",
            "readOnly":true
        },
        "outgoingMessageBacklog":{
            "type":"integer",
            "format":"int64",
            "description":"The backlog of the outgoing message queue.",
            "readOnly":true
        },
        "outgoingByteBacklog":{
            "type":"integer",
            "format":"int64",
            "description":"The backlog (in bytes) of the outgoing queue",
            "readOnly":true
        }
    }
}

Back to Top