Jump to

• Request
• Response

View Cache Information

get

/management/coherence/cluster/caches/{cacheName}

Use this endpoint to view general statistics for a cache. The information is aggregated across all cache members. Use the query parameters to change which aggregated results to view and to determine whether the results should be constrained to cluster members with a specific member role.

Request

Path Parameters

• cacheName: string
  Name of the cache.

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 information about a cache

Body ()

Root Schema : cacheAggregate

Type: object

Show Source

• averageMissMillis(optional): object summaryNumber
• highUnits(optional): integer(int64)
• name(optional): string
  Name of the cluster member.
• totalPutsMillis(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the cluster member."
        },
        "averageMissMillis":{
            "$ref":"#/definitions/summaryNumber"
        },
        "totalPutsMillis":{
            "type":"integer",
            "format":"int64"
        },
        "highUnits":{
            "type":"integer",
            "format":"int64"
        }
    }
}

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