.. _system_throughput_stats:

system throughput stats
=======================

Statistics for the object throughput


throughput Specification
------------------------

	===================================== ================================================================
	 **Parameter**                         **Value** 

	===================================== ================================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      throughput

	 **Element URI**                       /axapi/v3/system/throughput/stats

	 **Element Attributes**                throughput_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`throughput schema <system-throughput-stats/system-throughput-stats.txt>`
	===================================== ================================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/system/throughput/stats



.. raw:: html

   </td><td valign = 'top'>


:ref:`3427_throughput_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/system/throughput/stats



.. raw:: html

   </td><td valign = 'top'>


:ref:`3427_throughput_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/system/throughput/stats



.. raw:: html

   </td><td valign = 'top'>


:ref:`3427_throughput_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/system/throughput/stats



.. raw:: html

   </td><td valign = 'top'>


:ref:`3427_throughput_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/system/throughput/stats



.. raw:: html

   </td><td valign = 'top'>


:ref:`3427_throughput_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _3427_throughput_attributes:

throughput attributes
---------------------

    **stats**

        **Description:** stats is a **JSON Block**.  Please see below for :ref:`3427_stats` 

        **Type:** Object

.. _3427_stats:

stats
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **global-system-throughput-bits-per-sec**

        **Description** Global System throughput in bits/sec

        **Type:** number

        **Format:** counter

    **per-part-throughput-bits-per-sec**

        **Description** Partition throughput in bits/sec

        **Type:** number

        **Format:** counter