Metrics Get Gateway Status Metrics

Metrics Get Gateway Status Metrics

Fetch health metric summaries given a target gateway, time interval and list of metrics. On success, this method returns an object containing min, max and average values of requested metrics

Privileges required:

READ GATEWAY

Request
URI
POST
https://{api_host}/portal/rest/metrics/getGatewayStatusMetrics
COPY
Request Body

Show optional properties

{
    "gatewayId": 0
}
{
    "gatewayId": 0,
    "interval": {
        "end": "string",
        "start": "string"
    },
    "metrics": "gateway_metrics Object"
}
integer
gatewayId
Required

gatewayId

interval
interval
Optional

interval

gateway_metrics
metrics
Optional

metrics

Responses
200

Request was successfully processed

Returns gateway_status_metrics_summary of type(s) application/json 
"gateway_status_metrics_summary Object"
integer
total
Optional

total

object
tunnelCount
Optional

tunnelCount

object
memoryPct
Optional

memoryPct

object
flowCount
Optional

flowCount

object
cpuPct
Optional

cpuPct

object
handoffQueueDrops
Optional

handoffQueueDrops

object
connectedEdges
Optional

connectedEdges


400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"gatewayId:"integer"}' https://{api_host}/portal/rest/metrics/getGatewayStatusMetrics
On This Page
All Operations
POST
Metrics Get Edge App Link Metrics
POST
Metrics Get Edge App Link Series
POST
Metrics Get Edge App Metrics
POST
Metrics Get Edge App Series
POST
Metrics Get Edge Category Metrics
POST
Metrics Get Edge Category Series
POST
Metrics Get Edge Dest Metrics
POST
Metrics Get Edge Dest Series
POST
Metrics Get Edge Device Metrics
POST
Metrics Get Edge Device Series
POST
Metrics Get Edge Link Metrics
POST
Metrics Get Edge Link Series
POST
Metrics Get Edge Os Metrics
POST
Metrics Get Edge Os Series
POST
Metrics Get Edge Sdwan Peer Path Metrics
POST
Metrics Get Edge Sdwan Peer Path Series
POST
Metrics Get Edge Segment Metrics
POST
Metrics Get Edge Segment Series
POST
Metrics Get Edge Status Metrics
POST
Metrics Get Edge Status Series
POST
Metrics Get Enterprise Flow Metrics
POST
Metrics Get Gateway Status Metrics
POST
Metrics Get Gateway Status Series