REST API Reference for Managing Oracle Coherence

View Proxy Service Connection Information

get

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

Use this endpoint to view a list of client connections for a proxy service on a specific service member.

Request

Path Parameters

memberIdentifier(required): string

An identifier of the member, it can either be the name or the nodeId of the member.
serviceName(required): string

Name of the cache service.

Response

Supported Media Types

application/json

200 Response

A successful request that returns a list of proxy connections

Root Schema : schema

Type: object

Show Source

items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/proxyConnection"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object proxyConnection

Details of the remote proxy connection

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/proxyConnection"
    }
}

Nested Schema : proxyConnection

Type: object

Details of the remote proxy connection

Show Source

connectionTimeMillis: integer(int64)

Read Only: true

The time duration (in milliseconds) that the client has been connected.
location: string

Read Only: true

The location of the MBean server
member: string

Read Only: true

Name of the cluster member
messagingDebug: boolean

Debug flag. When true and the node's logging level is 6 or higher, sent and received messages will be logged for this connection. If this attribute in the ConnectionManager MBean is true and the node's logging level is 6 or higher, sent and received messages will also be logged.
nodeId: integer(int64)

Read Only: true

The ID of member to which the MBean belongs
outgoingByteBacklog: integer(int64)

Read Only: true

The backlog (in bytes) of the outgoing queue
outgoingMessageBacklog: integer(int32)

Read Only: true

The backlog of the outgoing message queue.
refreshTime: 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.
remoteAddress: string

Read Only: true

The IP address of the corresponding client.
remotePort: integer(int32)

Read Only: true

The port of the corresponding client.
timestamp: string(date-time)

Read Only: true

The date/time value (in local time) that the corresponding client connected to the Proxy.
totalBytesReceived: integer(int64)

Read Only: true

The total number of bytes received since the last time the statistics were reset.
totalBytesSent: integer(int64)

Read Only: true

The total number of bytes sent since the last time the statistics were reset.
totalMessagesReceived: integer(int64)

Read Only: true

The total number of messages received since the last time the statistics were reset.
totalMessagesSent: integer(int64)

Read Only: true

The total number of messages sent since the last time the statistics were reset.
type: string

Read Only: true

Allowed Values: [ "Connection" ]

The type of the MBean
UUID: string

Read Only: true

The unique identifier for this connection.

{
    "type":"object",
    "description":"Details of the remote proxy connection",
    "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":[
                "Connection"
            ],
            "readOnly":true
        },
        "member":{
            "type":"string",
            "description":"Name of the cluster member",
            "readOnly":true
        },
        "remoteAddress":{
            "type":"string",
            "description":"The IP address of the corresponding client.",
            "readOnly":true
        },
        "remotePort":{
            "type":"integer",
            "format":"int32",
            "description":"The port of the corresponding client.",
            "readOnly":true
        },
        "connectionTimeMillis":{
            "type":"integer",
            "format":"int64",
            "description":"The time duration (in milliseconds) that the client has been connected.",
            "readOnly":true
        },
        "totalBytesReceived":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of bytes received since the last time 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 this connection. If this attribute in the ConnectionManager MBean is true and the node's logging level is 6 or higher, sent and received messages will also be logged.",
            "readOnly":false
        },
        "totalBytesSent":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of bytes sent since the last time the statistics were reset.",
            "readOnly":true
        },
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "description":"The date/time value (in local time) that the corresponding client connected to the Proxy.",
            "readOnly":true
        },
        "totalMessagesSent":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of messages sent since the last time the statistics were reset.",
            "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
        },
        "totalMessagesReceived":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of messages received since the last time the statistics were reset.",
            "readOnly":true
        },
        "UUID":{
            "type":"string",
            "description":"The unique identifier for this connection.",
            "readOnly":true
        },
        "outgoingMessageBacklog":{
            "type":"integer",
            "format":"int32",
            "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
        }
    }
}