Monitoring Get Enterprise Aggregate Edge Nvs Tunnel Status

Monitoring Get Enterprise Aggregate Edge Nvs Tunnel Status

Returns an array where each entry represents a non-SD-WAN-via-Edge network service (e.g. Zscaler Cloud Security Service) with an aggregate tunnel state count object and an array of unique data centers that edges under the network service connect to.

Privileges required:

READ NETWORK_SERVICE

Request
URI
POST
https://{api_host}/portal/rest/monitoring/getEnterpriseAggregateEdgeNvsTunnelStatus
COPY
Request Body

Show optional properties

{
    "providerType": "string"
}
{
    "enterpriseId": 0,
    "providerObjectId": 0,
    "providerType": "string",
    "with": [
        "string"
    ]
}
integer
enterpriseId
Optional

enterpriseId

integer
providerObjectId
Optional

providerObjectId

string
providerType
Required

Non-SD-WAN-via-Edge network service type

Possible values are : cloudSecurityService, nvsViaEdgeService,
array of string
with
Optional

with

Possible values are : data, profileCount, edgeUsage, configuration, groupCount, edgeQOSUsage, saUsage, endpointUsage,
Responses
200

Request was successfully processed

[
    {
        "id": 0,
        "created": "string",
        "operatorId": 0,
        "networkId": 0,
        "enterpriseId": 0,
        "edgeId": 0,
        "gatewayId": 0,
        "parentGroupId": 0,
        "description": "string",
        "object": "string",
        "name": "string",
        "type": "string",
        "logicalId": "string",
        "alertsEnabled": 0,
        "operatorAlertsEnabled": 0,
        "status": "string",
        "statusModified": "string",
        "previousData": {},
        "previousCreated": "string",
        "draftData": "string",
        "draftCreated": "string",
        "draftComment": "string",
        "data": {},
        "lastContact": "string",
        "version": "string",
        "modified": "string",
        "profileCount": 0,
        "edgeCount": 0,
        "groupCount": 0,
        "edgeUsage": [
            {
                "enterpriseObjectId": 0,
                "configurationId": 0,
                "segmentObjectId": 0,
                "edgeSpecificId": 0,
                "name": "string",
                "logicalId": "string",
                "profileId": 0
            }
        ],
        "edgeQOSUsage": [
            {
                "segmentObjectId": 0,
                "edgeId": 0,
                "name": "string",
                "logicalId": "string",
                "profileId": 0
            }
        ],
        "endpointUsage": {
            "inUse": false,
            "count": 0,
            "associatedObjs": [
                {
                    "id": 0,
                    "created": "string",
                    "operatorId": 0,
                    "networkId": 0,
                    "enterpriseId": 0,
                    "edgeId": 0,
                    "gatewayId": 0,
                    "parentGroupId": 0,
                    "description": "string",
                    "object": "string",
                    "name": "string",
                    "type": "string",
                    "logicalId": "string",
                    "alertsEnabled": 0,
                    "operatorAlertsEnabled": 0,
                    "status": "string",
                    "statusModified": "string",
                    "previousData": {},
                    "previousCreated": "string",
                    "draftData": "string",
                    "draftCreated": "string",
                    "draftComment": "string",
                    "data": {},
                    "lastContact": "string",
                    "version": "string",
                    "modified": "string"
                }
            ]
        },
        "secureAccessCount": 0,
        "secureAccess": [
            {
                "id": 0,
                "name": "string"
            }
        ],
        "wssUsage": [
            {
                "configurationId": 0,
                "segmentObjectId": 0,
                "configurationName": "string",
                "segmentName": "string",
                "locationCount": 0
            }
        ],
        "tunnelCountByState": {
            "PENDING": 0,
            "UP": 0,
            "STANDBY": 0,
            "DOWN": 0,
            "UNKNOWN": 0
        },
        "dataCenters": [
            {
                "ipAddress": "string"
            }
        ]
    }
]

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 '{"providerType:"string"}' https://{api_host}/portal/rest/monitoring/getEnterpriseAggregateEdgeNvsTunnelStatus
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