.. _fw_rate_limit_stats:

fw rate-limit stats
===================

Statistics for the object rate-limit


rate-limit Specification
------------------------

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

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

	 **Element Name**                      rate-limit

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

	 **Element Attributes**                rate-limit_attributes

	 **Partition Visibility**              None

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



.. raw:: html

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


:ref:`959_rate-limit_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/stats



.. raw:: html

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


:ref:`959_rate-limit_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/stats



.. raw:: html

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


:ref:`959_rate-limit_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/stats



.. raw:: html

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


:ref:`959_rate-limit_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/stats



.. raw:: html

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


:ref:`959_rate-limit_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _959_rate-limit_attributes:

rate-limit attributes
---------------------

    **stats**

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

        **Type:** Object

.. _959_stats:

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

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

    **ratelimit_entry_count_fw_rule_uid**

        **Description** Number of Rate-limit Entries with Scope Aggregate

        **Type:** number

        **Format:** counter

    **ratelimit_entry_count_ip6_addr**

        **Description** Number of Rate-limit Entries with Scope IPv6 Address

        **Type:** number

        **Format:** counter

    **ratelimit_entry_count_ip_addr**

        **Description** Number of Rate-limit Entries with Scope IPv4 Address

        **Type:** number

        **Format:** counter

    **ratelimit_entry_count_parent_ipv4_prefix**

        **Description** Number of Parent Rate-limit Entries with Scope IPv4 Prefix

        **Type:** number

        **Format:** counter

    **ratelimit_entry_count_parent_ipv6_prefix**

        **Description** Number of Parent Rate-limit Entries with Scope IPv6 Prefix

        **Type:** number

        **Format:** counter

    **ratelimit_entry_count_parent_uid**

        **Description** Number of Parent Rate-limit Entries with Scope Aggregate

        **Type:** number

        **Format:** counter

    **ratelimit_entry_count_rule_ipv4_prefix**

        **Description** Number of Rate-limit Entries with Scope IPv4 Prefix

        **Type:** number

        **Format:** counter

    **ratelimit_entry_count_rule_ipv6_prefix**

        **Description** Number of Rate-limit Entries with Scope IPv6 Prefix

        **Type:** number

        **Format:** counter

    **ratelimit_entry_count_session_id**

        **Description** Number of Rate-limit Entries with Scope Session ID

        **Type:** number

        **Format:** counter

    **ratelimit_entry_count_t2_key**

        **Description** Number of Total Rate-limit Entries

        **Type:** number

        **Format:** counter

    **ratelimit_used_total_mem**

        **Description** Total Memory Used For Rate-limiting (bytes)

        **Type:** number

        **Format:** counter