Monitoring Get Enterprise Edge Status

Monitoring Get Enterprise Edge Status

Retrieves aggregate healthStats metric summariesfor a specified enterpriseId(and list of edges) over a specified time intervaland list of metrics. On success, this method returns an array ofhealthsStats objects for all requested edges and metrics

Privileges required:

READ EDGE

Request
URI
POST
https://{api_host}/portal/rest/monitoring/getEnterpriseEdgeStatus
COPY
Request Body
{
    "enterpriseId": 0,
    "edgeIds": [
        0
    ],
    "role": "string",
    "time": "js_date_formats Object",
    "sort": "edge_metric Object",
    "limit": 0,
    "metrics": "edge_metrics Object"
}
integer
enterpriseId
Optional

enterpriseId

array of integer
edgeIds
Optional

edgeIds

edge_ha_role
role
Optional
Constraints: default: ACTIVE

role

Possible values are : ACTIVE, STANDBY,
js_date_formats
time
Optional

time

edge_metric
sort
Optional

sort

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

limit

edge_metrics
metrics
Optional

metrics

Responses
200

Request was successfully processed

Returns monitoring_get_enterprise_edge_status_result of type(s) application/json 
"monitoring_get_enterprise_edge_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/getEnterpriseEdgeStatus
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