Versions Compared

Old Version 2

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method:

...

ethernetport - REST API Methods

...

This action retrieves the historical statistics for a given Ethernet Port in the

...

SBC

...

. The collections are over 1 hour intervals for a period of 1 day, thus giving a maximum of 24 historical records.

Info

The current interval is always the resource with ID 1. There will be a maximum of 25 rows returned for a lookup, where the row with ID 1 is the current interval being collected and the rows with ID 2-25 are the historical collections.


Tip

If no ID is specified, a listing of all collections will be returned along with their associated IDs. These identifiers can be used to get the individual resource element values.


URL:

https://

...

192.

...

168.

...

0.

...

111/rest/ethernetport/{identifier}/historicalstatistics

HTTP Method

GET

Requires Authentication

true


Noprint


Panel
bgColortransparent
titleBGColor#DDD
title[ethernetport - REST API Methods|Resource - ethernetport]

Page Tree
root@parent



Resource Schema

Statistics


Parameter NameDescriptionData TypePossible Values

...

rt_ifInUcastPktsDisplays the number of received unicast packets on this port.

rt_ifInBroadcastPktsDisplays the number of received broadcast packets on this port.

rt_ifInMulticastPktsDisplays the number of received multicast packets on this port.

rt_ifInOctetsDisplays the number of received octets on this port.

rt_ifInErrorsDisplays the number of errors detected on this port.

rt_ifInDiscardsDisplays the number of discard errors detected on this port.

rt_ifInUnknwnProtoDisplays the number of Unknown Protocol errors detected on this port.

rt_ifInUndersizedPktsDisplays the number of Undersized Packet errors detected on this port.

rt_ifInOverSizedPktsDisplays the number of Oversized Packet errors detected on this port.

rt_ifInFCSErrorsDisplays the number of discard Frame Check Sequence errors detected on this port.

rt_ifInAlignErrorsDisplays the number of Align errors detected on this port.

rt_ifInFragmentedPktsDisplays the number of Fragmented Packet errors detected on this port.

rt_ifOutUcastPktsDisplays the number of transmitted unicast packets on this port.

rt_ifOutOctetsDisplays the number of transmitted octets on this port.

rt_ifOutBroadcastPktsDisplays the number of transmitted broadcast packets on this port.

rt_ifOutMulticastPktsDisplays the number of transmitted multicast packets on this port.

rt_ifOutErrorsDisplays the number of errors detected on this port.

rt_ifOutDiscardsDisplays the number of discard errors detected on this port.

rt_ifOutLateCollissionsDisplays the number of Late Collision errors detected on this port.

rt_ifOutDeferredTransmissionsDisplays the number of Deferred Transmission errors detected on this port.

...

Usage Example: (about cURL | requires a session token)

Code Block
languagebash
curl --cookie PHPSESSID=ima0r3nkaeg8mo0suln67vg4m7 --cacert 134.56.227.163.crt 
-i https://134.56.227.163/rest/ethernetport/1/historicalstatistics

Response:

...

languagehtml/xml

...