Site topology quality of service statistics. This object provides quality of service related statistics for a single site topology entity, either site or a site link. Content-Type: application/vnd.plcm.plcm-site-topology-qos-statistics+xml. All attributes are used in ETag calculation except for entity-tag and atom-link.
| Name | Type | Description | Attributes |
|---|---|---|---|
| atomLinkList | Array of Link | See Definition of Link | |
| siteTopologyIdentifier | SiteTopologyIdentifier | Unique identifier of the site topology entity the statistics are being reported for. | Mandatory |
| type | Type | Type of the site topology entity the statistics are for. SITE - A private network composed of subnets SUBNET - A subnet of a private network (site) DIRECT_LINK - A network link between two sites | Mandatory |
| name | Name | Name of the site topology entity the statistics are being reported for. If the type of the site topology is SUBNET, the name will consist of the network address and subnet mask in CIDR (Classless InterDomain Routing) notation. For example A subnet with a network address of 192.168.0.0 and a subnet mask of 255.255.0.0 would be represented as 192.168.0.0/16 | |
| territoryName | TerritoryName | Name of the site topology territory the site topology entity belongs to. | |
| superclusterNodeName | SuperclusterNodeName | Name of the supercluster node the site topology territory is being managed by. | |
| managed | boolean | Flag indicating if the site topology entity is managed by the Call Server. If it is not being managed, then current statistics will not be available. | Mandatory |
| currentCallCount | int | The number of calls currently using this entity. | |
| usedBandwidthTotal | long | The total amount of bandwidth for all calls currently using this entity. This value is in bits per second (bps). | |
| usedBandwidthPercentage | unsignedShort | The percentage of used bandwidth for all calls currently using this entity. This field is only valid if the entity has an associated bandwidth limit. | |
| averageBitRate | long | The average bit rate being used for all calls currently using this entity. | |
| maximumDelay | int | The maximum amount of network delay (latency) for all calls currently using this entity. This is the maximum delay across all media streams (audio, and content). | |
| averageDelay | int | The average amount of network delay (latency) for each call currently using this entity. This is the average delay across all media streams(audio, video, and content). | |
| cumulativePacketLoss | int | The total packet loss for all calls currently using this entity. This is across all media streams (audio, video, and content). | |
| averagePacketLoss | int | The average packet loss for all calls currently using this entity. This is across all media streams (audio, video, and content). | |
| maximumJitter | int | The maximum amount of jitter for all calls currently using this entity. This is the maximum jitter across all media streams (audio, video, and content). | |
| averageJitter | int | The average amount of jitter for all calls currently using this entity This is the average jitter across all media streams (audio, video, and content). | |
| entityTag | EntityTag | The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance. |
| Name | Type | Restrictions |
|---|---|---|
| EntityTag | string | Length of value must be >=1 Length of value must be <=64 |
| SuperclusterNodeName | string | Length of value must be >=1 Length of value must be <=128 |
| TerritoryName | string | Length of value must be >=1 Length of value must be <=128 |
| Name | string | Length of value must be >=1 Length of value must be <=128 |
| Type | string | Value must be one of:
|
| SiteTopologyIdentifier | string | Length of value must be >=1 Length of value must be <=36 |