.. _scaleout_cluster_local_device_tracking_template_multi_template:

scaleout cluster local-device tracking-template multi-template
==============================================================

Configure multi tracking template to be used by scaleout


multi-template Specification
----------------------------

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

	===================================== =====================================================================================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *multi-template*

	 **Collection Name**                   :ref:`2605_multi-template_list`

	 **Collection URI**                    /axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template/multi-template

	                                       

	 **Element Name**                      multi-template

	 **Element URI**                       /axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template/multi-template/{multi-template}

	 **Element Attributes**                multi-template_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`multi-template schema <scaleout-cluster-local-device-tracking-template-multi-template/scaleout-cluster-local-device-tracking-template-multi-template.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/scaleout/cluster/{cluster-id}/local-device/tracking-template/multi-template



.. raw:: html

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


:ref:`2605_multi-template_attributes`



.. raw:: html

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




.. raw:: html

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


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template/multi-template



.. raw:: html

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


:ref:`2605_multi-template_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/scaleout/cluster/{cluster-id}/local-device/tracking-template/multi-template/{multi-template}



.. raw:: html

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


:ref:`2605_multi-template_attributes`



.. raw:: html

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




.. raw:: html

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


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template/multi-template



.. raw:: html

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


:ref:`2605_multi-template_list`



.. 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/scaleout/cluster/{cluster-id}/local-device/tracking-template/multi-template/{multi-template}



.. raw:: html

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


:ref:`2605_multi-template_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/scaleout/cluster/{cluster-id}/local-device/tracking-template/multi-template/{multi-template}



.. raw:: html

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


:ref:`2605_multi-template_attributes`



.. raw:: html

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




.. raw:: html

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


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template/multi-template



.. raw:: html

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


:ref:`2605_multi-template_list`



.. 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/scaleout/cluster/{cluster-id}/local-device/tracking-template/multi-template/{multi-template}



.. raw:: html

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


:ref:`2605_multi-template_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2605_multi-template_list:

multi-template-list
-------------------


    multi-template-list is **JSON List** of :ref:`2605_multi-template_attributes` 

        multi-template-list : [

             { :ref:`2605_multi-template_attributes` },

             { :ref:`2605_multi-template_attributes` },

             ...

         ]

.. _2605_multi-template_attributes:

multi-template attributes
-------------------------

    **action**

        **Description** 'down': node stops processing user traffic; 'exit-cluster': node exits scaleout cluster; 

        **Type:** string

        **Supported Values:** down, exit-cluster

    **multi-template**

        **Description** bind multi tracking template name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **template**

        **Type:** List

    **threshold**

        **Description** action triggering threshold

        **Type:** number

        **Range:** 1-65535

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2605_template:

template
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **partition-name**

        **Description** Partition name

        **Type:** string

        **Maximum Length:** 14 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/partition <partition>`

    **template-name**

        **Description** bind tracking template name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters