DomainKindSummary

Represents a readonly domain summary object - various attributes of this object are gathered from Domain, Zones, SubNetwork, NSGInfo objects

Overview

criticalAlarmsCount integer read only   filterable   orderable  
domainKindDescription string read only   filterable   orderable  
domainKindName string read only   filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
gatewayCount integer read only   filterable   orderable  
infoAlarmsCount integer read only   filterable   orderable  
lastUpdatedBy string autogenerated  
majorAlarmsCount integer read only   filterable   orderable  
meshGroupCount integer read only   filterable   orderable  
minorAlarmsCount integer read only   filterable   orderable  
nsgCount integer read only   filterable   orderable  
subNetworkCount integer read only   filterable   orderable  
trafficVolume integer read only   filterable   orderable  
zoneCount integer read only   filterable   orderable  

API Resource

/domainkindsummaries/id
get

Parents

/enterprises/id/domainkindsummaries
get

Children

/domainkindsummaries/id/metadatas
get post
/domainkindsummaries/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

criticalAlarmsCount integer read only   filterable   orderable  
Discussion

Total count of alarms with CRITICAL severity

Charateristics

Max value: 2147483647
SDK attribute: criticalAlarmsCount

domainKindDescription string read only   filterable   orderable  
Discussion

A description string of the domain that is provided by the user

Charateristics

Format: free
Max length: 255
SDK attribute: domainKindDescription

domainKindName string read only   filterable   orderable  
Discussion

The name of the domain. Valid characters are alphabets, numbers, space and hyphen( - ).

Charateristics

Format: free
Max length: 255
SDK attribute: domainKindName

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

gatewayCount integer read only   filterable   orderable  
Discussion

Total count of gateways in this domain

Charateristics

Max value: 2147483647
SDK attribute: gatewayCount

infoAlarmsCount integer read only   filterable   orderable  
Discussion

Total count of alarms with INFO severity

Charateristics

Max value: 2147483647
SDK attribute: infoAlarmsCount

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

majorAlarmsCount integer read only   filterable   orderable  
Discussion

Total count of alarms at MAJOR severity

Charateristics

Max value: 2147483647
SDK attribute: majorAlarmsCount

meshGroupCount integer read only   filterable   orderable  
Discussion

Total count of mesh groups in this domain

Charateristics

Max value: 2147483647
SDK attribute: meshGroupCount

minorAlarmsCount integer read only   filterable   orderable  
Discussion

Total count of alarms with MINOR severity

Charateristics

Max value: 2147483647
SDK attribute: minorAlarmsCount

nsgCount integer read only   filterable   orderable  
Discussion

Total count of nsg in this domain

Charateristics

Max value: 2147483647
SDK attribute: nsgCount

subNetworkCount integer read only   filterable   orderable  
Discussion

Total count of sub networks in this domain

Charateristics

Max value: 2147483647
SDK attribute: subNetworkCount

trafficVolume integer read only   filterable   orderable  
Discussion

Traffic volume within the domain in GB indicating whether the network is running ZERO, light, medium or heavy traffic based on last 24 hours traffic stats

Charateristics

SDK attribute: trafficVolume

zoneCount integer read only   filterable   orderable  
Discussion

Total count of zones in this domain

Charateristics

Max value: 2147483647
SDK attribute: zoneCount