.. _fw_rate_limit_summary:

fw rate-limit summary
=====================

View A Summary About Rate Limit Entries


summary Specification
---------------------

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

	 **Element Name**                      summary

	 **Element URI**                       /axapi/v3/fw/rate-limit/summary

	 **Element Attributes**                summary_attributes

	 **Operational Data URI**              /axapi/v3/fw/rate-limit/summary/oper

	 **Schema**                             :download:`summary schema <fw-rate-limit-summary/fw-rate-limit-summary.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/fw/rate-limit/summary



.. raw:: html

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


:ref:`701_summary_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/fw/rate-limit/summary



.. raw:: html

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


:ref:`701_summary_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/fw/rate-limit/summary



.. raw:: html

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


:ref:`701_summary_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/fw/rate-limit/summary



.. raw:: html

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


:ref:`701_summary_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/fw/rate-limit/summary



.. raw:: html

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


:ref:`701_summary_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _701_summary_attributes:

summary attributes
------------------

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _701_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - total_entries_scope_aggregate
      - number
      - total_entries_scope_aggregate

   *  - 
      - total_entries_scope_subscriber_prefix
      - number
      - total_entries_scope_subscriber_prefix

   *  - 
      - mem_reserved
      - number
      - mem_reserved

   *  - 
      - total_entries_scope_subscriber_ip
      - number
      - total_entries_scope_subscriber_ip

   *  - 
      - mem_used
      - number
      - mem_used

   *  - 
      - total_num_entries
      - number
      - total_num_entries

   *  - 
      - alloc_failures
      - number
      - alloc_failures