.. _fw_top_k_rules_oper:

fw top-k-rules oper
===================

Operational Status for the object top-k-rules


top-k-rules Specification
-------------------------

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

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

	 **Element Name**                      top-k-rules

	 **Element URI**                       /axapi/v3/fw/top-k-rules/oper

	 **Element Attributes**                top-k-rules_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`top-k-rules schema <fw-top-k-rules-oper/fw-top-k-rules-oper.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/top-k-rules/oper



.. raw:: html

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


:ref:`1690_top-k-rules_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/top-k-rules/oper



.. raw:: html

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


:ref:`1690_top-k-rules_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/top-k-rules/oper



.. raw:: html

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


:ref:`1690_top-k-rules_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/top-k-rules/oper



.. raw:: html

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


:ref:`1690_top-k-rules_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/top-k-rules/oper



.. raw:: html

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


:ref:`1690_top-k-rules_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1690_top-k-rules_attributes:

top-k-rules attributes
----------------------

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`1690_oper` 

        **Type:** Object

.. _1690_oper:

oper
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **metric-topk-list**

        **Type:** List

.. _1690_oper_metric-topk-list:

oper_metric-topk-list
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **metric-name**

        **Description** 

        **Type:** string

    **topk-list**

        **Type:** List

.. _1690_oper_metric-topk-list_topk-list:

oper_metric-topk-list_topk-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **metric-value**

        **Description** 

        **Type:** number

    **rule-name**

        **Description** 

        **Type:** string