GET /api/monitoring/metrics/totals

Description

This method gets metric totals for a Metric Group. Metric totals are a running total count for the group since the API Server was started. The set of metric values returned will vary depending on the metric group type.

The Monitoring API resides in the API Servers, therefore this method must be invoked via the Routing API in the Admin Node Manager.


Resource URL

https://localhost:8090/api/router/service/{serviceID}/api/monitoring/metrics/totals
https://localhost:8090/api/router/service/{serviceID}/api/monitoring/metrics/totals?type={type}&name={name}


Parameters

type optional The metric group type, e.g. "Service", "Client", "TargetServer". This defaults to SystemOverview.
name optional The metric group name. This defaults to System overview.

Response Codes

Response Code Description
200 Success. The response body contains a list of metric totals for a metric group of a particular type and name.

Example Request and Response

GET https://localhost:8090/api/router/service/instance-1/api/monitoring/metrics/totals?type=Service&name=StockQuote

HTTP 1.1 200 OK

{
    "result": [
        {
            "groupType": "Service",
            "groupId": 9,
            "failures": 9,
            "exceptions": 0,
            "groupName": "StockQuote",
            "numMessages": 16,
            "successes": 7,
            "processingTimeMin": 3,
            "processingTimeMax": 670,
            "uptime": 582,
            "processingTimeAvg": 0
        }
    ]
}