.. _slb_template_dns_response_rate_limiting:

slb template dns response-rate-limiting
=======================================

DNS Response Rate Limiting


response-rate-limiting Specification
------------------------------------

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

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

	 **Element Name**                      response-rate-limiting

	 **Element URI**                       /axapi/v3/slb/template/dns/{name}/response-rate-limiting

	 **Element Attributes**                response-rate-limiting_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`response-rate-limiting schema <slb-template-dns-response-rate-limiting/slb-template-dns-response-rate-limiting.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}/response-rate-limiting



.. raw:: html

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


:ref:`2982_response-rate-limiting_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_response_rate_limiting_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}/response-rate-limiting



.. raw:: html

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


:ref:`2982_response-rate-limiting_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_response_rate_limiting_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}/response-rate-limiting



.. raw:: html

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


:ref:`2982_response-rate-limiting_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}/response-rate-limiting



.. raw:: html

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


:ref:`2982_response-rate-limiting_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_response_rate_limiting_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}/response-rate-limiting



.. raw:: html

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


:ref:`2982_response-rate-limiting_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_response_rate_limiting_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2982_response-rate-limiting_attributes:

response-rate-limiting attributes
---------------------------------

    **TC-rate**

        **Description** Every n'th response that would be rate-limited will respond with TC bit

        **Type:** number

        **Range:** 2-10

        **Mutual Exclusion:** TC-rate and slip-rate are mutually exclusive

    **action**

        **Description** 'log-only': Only log rate-limiting, do not actually rate limit. Requires enable-log configuration; 'rate-limit': Rate-Limit based on configuration (Default); 'whitelist': Whitelist, disable rate-limiting; 

        **Type:** string

        **Supported Values:** log-only, rate-limit, whitelist

        **Default:** rate-limit

    **enable-log**

        **Description** Enable logging

        **Type:** boolean

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

        **Default:** 0

    **filter-response-rate**

        **Description** Maximum allowed request rate for the filter. This should match average traffic. (default 10 per seconds)

        **Type:** number

        **Range:** 1-1000

        **Default:** 10

    **match-subnet**

        **Description** IP subnet mask (response rate by IP subnet mask)

        **Type:** string

        **Format:** ipv4-netmask

        **Default:** 255.255.255.255

    **match-subnet-v6**

        **Description** IPV6 subnet mask (response rate by IPv6 subnet mask)

        **Type:** number

        **Range:** 1-128

        **Default:** 128

    **response-rate**

        **Description** Responses exceeding this rate within the window will be dropped (default 5 per second)

        **Type:** number

        **Range:** 1-1000

        **Default:** 5

    **rrl-class-list-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/response-rate-limiting/rrl-class-list/{name} <slb_template_dns>`

    **slip-rate**

        **Description** Every n'th response that would be rate-limited will be let through instead

        **Type:** number

        **Range:** 2-10

        **Mutual Exclusion:** slip-rate and TC-rate are mutually exclusive

    **src-ip-only**

        **Description** 

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **window**

        **Description** Rate-Limiting Interval in Seconds (default is one)

        **Type:** number

        **Range:** 1-60

        **Default:** 1

.. _2982_rrl-class-list-list:

rrl-class-list-list
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **lid-list**

        **Type:** List

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

    **name**

        **Description** Class-list name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

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

.. _2982_rrl-class-list-list_lid-list:

rrl-class-list-list_lid-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **lid-action**

        **Description** 'log-only': Only log rate-limiting, do not actually rate limit. Requires enable-log configuration; 'rate-limit': Rate-Limit based on configuration (Default); 'whitelist': Whitelist, disable rate-limiting; 

        **Type:** string

        **Supported Values:** log-only, rate-limit, whitelist

        **Default:** rate-limit

    **lid-enable-log**

        **Description** Enable logging

        **Type:** boolean

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

        **Default:** 0

    **lid-match-subnet**

        **Description** IP subnet mask (response rate by IP subnet mask)

        **Type:** string

        **Format:** ipv4-netmask

        **Default:** 255.255.255.255

    **lid-match-subnet-v6**

        **Description** IPV6 subnet mask (response rate by IPv6 subnet mask)

        **Type:** number

        **Range:** 1-128

        **Default:** 128

    **lid-response-rate**

        **Description** Responses exceeding this rate within the window will be dropped (default 5 per second)

        **Type:** number

        **Range:** 1-1000

        **Default:** 5

    **lid-slip-rate**

        **Description** Every n'th response that would be rate-limited will be let through instead

        **Type:** number

        **Range:** 2-10

        **Mutual Exclusion:** lid-slip-rate and lid-tc-rate are mutually exclusive

    **lid-src-ip-only**

        **Description** 

        **Type:** boolean

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

        **Default:** 0

    **lid-tc-rate**

        **Description** Every n'th response that would be rate-limited will respond with TC bit

        **Type:** number

        **Range:** 2-10

        **Mutual Exclusion:** lid-tc-rate and lid-slip-rate are mutually exclusive

    **lid-window**

        **Description** Rate-Limiting Interval in Seconds (default is one)

        **Type:** number

        **Range:** 1-60

        **Default:** 1

    **lidnum**

        **Description** Specify a limit ID

        **Type:** number

        **Range:** 1-1023

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