GET /api/monitoring/summary

Description

This method retrieves summary API Server status information. This status information includes metrics totals for the API Server, e.g. the number of passed requests, failed requests and exception requests.

The metrics returned here are the same as the metrics that would be returned as a result of GET https://localhost:8090/api/monitoring/metrics/totals or GET https://localhost:8090/api/monitoring/metrics/totals?name=System%20overview&type=SystemOverview.

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/summary

---

Parameters

---

Response Codes

Response Code	Description
200	Success. The response body contains summary metrics data. Refer to Javadoc for com.vordel.api.monitoring.model.Summary.

---

Example Request and Response

GET https://localhost:8090/api/router/service/instance-1/api/monitoring/summary

HTTP 1.1 200 OK

{
    "result": {
        "id": "instance-1",
        "name": "APIServer1",
        "groupId": "group-2",
        "groupName": "Group1",
        "hostName": "HostOne",
        "summaryMetrics": {
            "groupName": "System overview",
            "cpuUsed": 0,
            "systemMemoryUsed": 274696,
            "metricsStoreError": 0,
            "cpuUsedMax": 1,
            "memoryUsedMin": 269664,
            "cpuUsedAvg": 0,
            "diskUsedPercent": 56,
            "exceptions": 0,
            "numMessagesProcessed": 0,
            "systemCpuAvg": 0,
            "messageMonitoringEnabled": "false",
            "metricsStoreFatalError": 0,
            "metricsStoringEnabled": "false",
            "processSignature": "Melissa-PC:instance-1",
            "groupType": "SystemOverview",
            "failures": 0,
            "successes": 0,
            "serverTitle": "instance-1",
            "uptime": 4367,
            "numSLABreaches": 0,
            "serverHost": "Melissa-PC",
            "memoryUsedMax": 289664,
            "cpuUsedMin": 0,
            "groupId": 6,
            "numAlerts": 0,
            "monitoringEnabled": "true",
            "systemCpuMin": 4,
            "serverGroup": "group-2",
            "systemCpuMax": 64,
            "systemMemoryTotal": 16776496,
            "memoryUsedAvg": 0,
            "numClients": 0
        }
    }
}