Jump to

• Request
• Response

View Aggregated Platform Memory

get

/management/coherence/cluster/platform/memory

Use this endpoint to view memory usage aggregated across all Coherence cluster members.

Request

Query Parameters

• collector: string
  The collector to use for aggregation

  Allowed Values: [ "all", "avg", "count", "list", "max", "min", "set", "sum", "intsummary", "longsummary", "doublesummary" ]
• role: string
  The data from cluster member belonging to the role will be included in the response

Back to Top

Response

Supported Media Types

• application/json

200 Response

A successful request that returns aggregated memory usage

Body ()

Root Schema : jvmMemoryAggregate

Type: object

Show Source

• heapMemoryUsage(optional): object memoryUsage
• nonHeapMemoryUsage(optional): object memoryUsage
• objectPendingFinalizationCount(optional): object summaryNumber

{
    "type":"object",
    "properties":{
        "heapMemoryUsage":{
            "$ref":"#/definitions/memoryUsage"
        },
        "nonHeapMemoryUsage":{
            "$ref":"#/definitions/memoryUsage"
        },
        "objectPendingFinalizationCount":{
            "$ref":"#/definitions/summaryNumber"
        }
    }
}

Nested Schema : memoryUsage

Type: object

Show Source

• committed(optional): object summaryNumber
• init(optional): object summaryNumber
• max(optional): object summaryNumber
• used(optional): object summaryNumber

{
    "type":"object",
    "properties":{
        "init":{
            "$ref":"#/definitions/summaryNumber"
        },
        "committed":{
            "$ref":"#/definitions/summaryNumber"
        },
        "max":{
            "$ref":"#/definitions/summaryNumber"
        },
        "used":{
            "$ref":"#/definitions/summaryNumber"
        }
    }
}

Nested Schema : summaryNumber

Type: object

Show Source

• average(optional): integer(int64)
• count(optional): integer(int64)
• max(optional): integer(int64)
• min(optional): integer(int64)
• sum(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "sum":{
            "type":"integer",
            "format":"int64"
        },
        "average":{
            "type":"integer",
            "format":"int64"
        },
        "min":{
            "type":"integer",
            "format":"int64"
        },
        "max":{
            "type":"integer",
            "format":"int64"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Back to Top