.. _slb_template_link_cost:

slb template link-cost
======================

Server Link-Cost Template


link-cost Specification
-----------------------

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

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

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`3003_link-cost_list`

	 **Collection URI**                    /axapi/v3/slb/template/link-cost

	                                       

	 **Element Name**                      link-cost

	 **Element URI**                       /axapi/v3/slb/template/link-cost/{name}

	 **Element Attributes**                link-cost_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`link-cost schema <slb-template-link-cost/slb-template-link-cost.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/slb/template/link-cost



.. raw:: html

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


:ref:`3003_link-cost_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/slb_template_link_cost_POST.txt
   :literal:




.. raw:: html

   </div></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/slb/template/link-cost



.. raw:: html

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


:ref:`3003_link-cost_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/slb/template/link-cost/{name}



.. raw:: html

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


:ref:`3003_link-cost_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/slb_template_link_cost_GET.txt
   :literal:




.. raw:: html

   </div></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/slb/template/link-cost



.. raw:: html

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


:ref:`3003_link-cost_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/slb/template/link-cost/{name}



.. raw:: html

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


:ref:`3003_link-cost_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/slb/template/link-cost/{name}



.. raw:: html

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


:ref:`3003_link-cost_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/slb_template_link_cost_PUT.txt
   :literal:




.. raw:: html

   </div></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/slb/template/link-cost



.. raw:: html

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


:ref:`3003_link-cost_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/slb/template/link-cost/{name}



.. raw:: html

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


:ref:`3003_link-cost_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/slb_template_link_cost_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3003_link-cost_list:

link-cost-list
--------------


    link-cost-list is **JSON List** of :ref:`3003_link-cost_attributes` 

        link-cost-list : [

             { :ref:`3003_link-cost_attributes` },

             { :ref:`3003_link-cost_attributes` },

             ...

         ]

.. _3003_link-cost_attributes:

link-cost attributes
--------------------

    **bandwidth-interval**

        **Description** Interval duration in seconds

        **Type:** number

        **Range:** 1-60

        **Default:** 5

    **name**

        **Description** Server Link-Cost Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **overage-bandwidth-cost**

        **Description** Configure overage bandwidth cost on real server (Overage bandwidth cost per Mbpi)

        **Type:** number

        **Range:** 0-4294967295

        **Default:** 0

    **prepaid-bandwidth**

        **Description** Configure prepaid bandwidth on real server (Prepaid Bandwidth in Mbpi)

        **Type:** number

        **Range:** 0-4294967295

        **Default:** 0

    **sampling-enable**

        **Type:** List

    **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

.. _3003_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'link_total_fwd_bytes': Total bytes fwd for link; 'interval_fwd_bytes': Link Cost bytes processed in forward direction per interval; 'link_total_conn': Link Cost total connection; 'interval_avg_throughput': Link Cost average throughput per interval; 'interval_max_throughput': Link Cost max throughput per interval; 

        **Type:** string

        **Supported Values:** all, link_total_fwd_bytes, interval_fwd_bytes, link_total_conn, interval_avg_throughput, interval_max_throughput