Versions Compared

Old Version 2

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version 3

changes.mady.by.user Ribbon Communications

Saved on

Key

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

REST API Method: GET /rest/ethernetport/{identifier}/historicalstatistics

ethernetport - REST API Methods
Page Tree
rootResource - ethernetport

This action retrieves the historical statistics for a given Ethernet Port in the Sonus SBC 1000/2000 system. 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://134.56.227.163/rest/ethernetport/{identifier}/historicalstatistics

HTTP Method

GET

Requires Authentication

true

Resource Schema

Statistics

Description
Parameter Name Description Data Type Possible Values
rt_ifInUcastPktsDisplays the number of received unicast packets on this port.long
rt_ifInBroadcastPkts Displays the number of received broadcast packets on this port.long
rt_ifInMulticastPktsDisplays the number of received multicast packets on this port.long
rt_ifInOctets Displays the number of received octets on this port. long
rt_ifInErrorsDisplays the number of errors detected on this port.long
rt_ifInDiscardsDisplays the number of discard errors detected on this port.long
rt_ifInUnknwnProtoDisplays the number of Unknown Protocol errors detected on this port.long
rt_ifInUndersizedPktsDisplays the number of Undersized Packet errors detected on this port.long
rt_ifInOverSizedPktsDisplays the number of Oversized Packet errors detected on this port.long
rt_ifInFCSErrorsDisplays the number of discard Frame Check Sequence errors detected on this port.long
rt_ifInAlignErrorsDisplays the number of Align errors detected on this port.long
rt_ifInFragmentedPktsDisplays the number of Fragmented Packet errors detected on this port.long
rt_ifOutUcastPktsDisplays the number of transmitted unicast packets on this port.long
rt_ifOutOctets Displays the number of transmitted octets on this port. long
rt_ifOutBroadcastPktsDisplays the number of transmitted broadcast packets on this port.long
rt_ifOutMulticastPkts Displays the number of transmitted multicast packets on this port.long
rt_ifOutErrorsDisplays the number of errors detected on this port.long
rt_ifOutDiscardsDisplays the number of discard errors detected on this port.long
rt_ifOutLateCollissionsDisplays the number of Late Collision errors detected on this port.long
rt_ifOutDeferredTransmissionsDisplays the number of Deferred Transmission errors detected on this port.long

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:

Code Block
languagehtml/xml
<?xml version="1.0"?> 
<root>
   <status>
     <http_code>200</http_code>
   </status>
   <historicalstatistics_list count="3">
       <historicalstatistics_pk id="1:1" href="https://134.56.227.163/rest/ethernetport/1/historicalstatistics/1"/>
       <historicalstatistics_pk id="1:2" href="https://134.56.227.163/rest/ethernetport/1/historicalstatistics/2"/>
       <historicalstatistics_pk id="1:3" href="https://134.56.227.163/rest/ethernetport/1/historicalstatistics/3"/>
   </historicalstatistics_list>
</root>