.. _slb_template_dns_class_list:

slb template dns class-list
===========================

Classification list


class-list Specification
------------------------

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

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

	 **Element Name**                      class-list

	 **Element URI**                       /axapi/v3/slb/template/dns/{name}/class-list

	 **Element Attributes**                class-list_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`class-list schema <slb-template-dns-class-list/slb-template-dns-class-list.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/dns/{name}/class-list



.. raw:: html

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


:ref:`2967_class-list_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_dns_class_list_POST.txt
   :literal:




.. raw:: html

   </div></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/dns/{name}/class-list



.. raw:: html

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


:ref:`2967_class-list_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_dns_class_list_GET.txt
   :literal:




.. raw:: html

   </div></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/dns/{name}/class-list



.. raw:: html

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


:ref:`2967_class-list_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/dns/{name}/class-list



.. raw:: html

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


:ref:`2967_class-list_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_dns_class_list_PUT.txt
   :literal:




.. raw:: html

   </div></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/dns/{name}/class-list



.. raw:: html

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


:ref:`2967_class-list_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_dns_class_list_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2967_class-list_attributes:

class-list attributes
---------------------

    **lid-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/class-list/lid/{lidnum} <slb_template_dns>`

    **name**

        **Description** Specify a class list name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2967_lid-list:

lid-list
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action-value**

        **Description** 'dns-cache-disable': Disable DNS cache when it exceeds limit; 'dns-cache-enable': Enable DNS cache when it exceeds limit; 'forward': Forward the traffic even it exceeds limit; 

        **Type:** string

        **Supported Values:** dns-cache-disable, dns-cache-enable, forward

    **conn-rate-limit**

        **Description** Connection rate limit

        **Type:** number

        **Range:** 1-2147483647

    **dns**

        **Description:** dns is a **JSON Block**.  Please see below for :ref:`2967_lid-list_dns` 

        **Type:** Object

    **lidnum**

        **Description** Specify a limit ID

        **Type:** number

        **Range:** 1-1023

    **lockout**

        **Description** Don't accept any new connection for certain time (Lockout duration in minutes)

        **Type:** number

        **Range:** 1-1023

    **log**

        **Description** Log a message

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **log-interval**

        **Description** Log interval (minute, by default system will log every over limit instance)

        **Type:** number

        **Range:** 1-255

    **over-limit-action**

        **Description** Action when exceeds limit

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **per**

        **Description** Per (Number of 100ms)

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

.. _2967_lid-list_dns:

lid-list_dns
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **cache-action**

        **Description** 'cache-disable': Disable dns cache; 'cache-enable': Enable dns cache; 

        **Type:** string

        **Supported Values:** cache-disable, cache-enable

        **Default:** cache-disable

    **honor-server-response-ttl**

        **Description** Honor the server reponse TTL

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **ttl**

        **Description** TTL for cache entry (TTL in seconds)

        **Type:** number

        **Range:** 1-65535

    **weight**

        **Description** Weight for cache entry

        **Type:** number

        **Range:** 1-7