Monitoring Get Network Gateway Status

Monitoring Get Network Gateway Status

Fetch aggregate health metric summaries for all gateways in a network or for given list of target gateways, for specified time interval and list of metrics. On success, this method returns an array of objects per gateway containing health metric summary of requested metrics

Privileges required:

READ GATEWAY

Request
URI
POST
https://{api_host}/portal/rest/monitoring/getNetworkGatewayStatus
COPY
Request Body
{
    "networkId": 0,
    "gatewayIds": [
        0
    ],
    "time": "string",
    "sort": "gateway_metric Object",
    "limit": 0,
    "metrics": "gateway_metrics Object"
}
integer
networkId
Optional

networkId

array of integer
gatewayIds
Optional

gatewayIds

js_date_formats
time
Optional

time

gateway_metric
sort
Optional

sort

Possible values are : tunnelCount, memoryPct, flowCount, cpuPct, handoffQueueDrops, connectedEdges, tunnelCountV6,
integer
limit
Optional
Constraints: minimum: 0

limit

gateway_metrics
metrics
Optional

metrics

Responses
200

Request was successfully processed

Returns monitoring_get_network_gateway_status_result of type(s) application/json 
"monitoring_get_network_gateway_status_result Object"
object
metaData
Required

metaData

array of object
data
Required

data


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 '{}' https://{api_host}/portal/rest/monitoring/getNetworkGatewayStatus
On This Page
All Operations
POST
Monitoring Get Aggregate Edge Link Metrics
POST
Monitoring Get Aggregate Enterprise Events
POST
Monitoring Get Aggregates
POST
Monitoring Get Enterprise Aggregate Edge Nvs Tunnel Status
POST
Monitoring Get Enterprise Bgp Peer Status
POST
Monitoring Get Enterprise Edge Bfd Peer Status
POST
Monitoring Get Enterprise Edge Bgp Peer Status
POST
Monitoring Get Enterprise Edge Cluster Status
POST
Monitoring Get Enterprise Edge Link Status
POST
Monitoring Get Enterprise Edge Nvs Tunnel Status
POST
Monitoring Get Enterprise Edge Status
POST
Monitoring Get Network Gateway Status
POST
Monitoring Get Vpn Edge Action Status
POST
Monitoring Get Vpn Site Status
POST
Monitoring Get Wss Location Creation Status