Jump to

• Request
• Response

View Service Information

get

/management/coherence/cluster/services/{serviceName}

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

Request

Path Parameters

• serviceName: string
  Name of the cache service.

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 performance metrics for a service

Body ()

Root Schema : serviceAggregate

Type: object

Show Source

• messagesSent(optional): object summaryNumber
• name(optional): string
  Name of the service.
• persistenceLatencyMax(optional): integer(int64)
• taskMaxBacklog(optional): integer(int64)
• threadAverageActiveCount(optional): object summaryNumber
• threadCountMax(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the service."
        },
        "threadAverageActiveCount":{
            "$ref":"#/definitions/summaryNumber"
        },
        "threadCountMax":{
            "type":"integer",
            "format":"int64"
        },
        "taskMaxBacklog":{
            "type":"integer",
            "format":"int64"
        },
        "messagesSent":{
            "$ref":"#/definitions/summaryNumber"
        },
        "persistenceLatencyMax":{
            "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