.. _slb_template_policy_class_list:

slb template policy class-list
==============================

Configure classification list


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

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

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

	 **Element Name**                      class-list

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

	 **Element Attributes**                class-list_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3016_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_policy_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/policy/{name}/class-list



.. raw:: html

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


:ref:`3016_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_policy_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/policy/{name}/class-list



.. raw:: html

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


:ref:`3016_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/policy/{name}/class-list



.. raw:: html

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


:ref:`3016_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_policy_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/policy/{name}/class-list



.. raw:: html

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


:ref:`3016_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_policy_class_list_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3016_class-list_attributes:

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

    **client-ip-l3-dest**

        **Description** Use destination IP as client IP address

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** client-ip-l3-dest and client-ip-l7-header are mutually exclusive

    **client-ip-l7-header**

        **Description** Use extract client IP address from L7 header

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** client-ip-l7-header and client-ip-l3-dest are mutually exclusive

    **header-name**

        **Description** Specify L7 header name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **lid-list**

        **Type:** List

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

    **name**

        **Description** Class list name or geo-location-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

.. _3016_lid-list:

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

	 **Block object keys**             

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

    **action-value**

        **Description** 'forward': Forward the traffic even it exceeds limit; 'reset': Reset the connection when it exceeds limit; 

        **Type:** string

        **Supported Values:** forward, reset

    **bw-per**

        **Description** Per (Specify interval in number of 100ms)

        **Type:** number

        **Range:** 1-65535

    **bw-rate-limit**

        **Description** Specify bandwidth rate limit (Bandwidth rate limit in bytes)

        **Type:** number

        **Range:** 1-2147483647

    **conn-limit**

        **Description** Connection limit

        **Type:** number

        **Range:** 0-1048575

    **conn-per**

        **Description** Per (Specify interval in number of 100ms)

        **Type:** number

        **Range:** 1-65535

    **conn-rate-limit**

        **Description** Specify connection rate limit

        **Type:** number

        **Range:** 1-2147483647

    **direct-action**

        **Description** Set action when match the lid

        **Type:** boolean

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

        **Default:** 0

    **direct-action-interval**

        **Description** Specify logging interval in minute (default is 3)

        **Type:** number

        **Range:** 0-60

        **Default:** 3

    **direct-action-value**

        **Description** 'drop': drop the packet; 'reset': Send reset back; 

        **Type:** string

        **Supported Values:** drop, reset

        **Mutual Exclusion:** direct-action-value and direct-service-group are mutually exclusive

    **direct-fail**

        **Description** Only log unsuccessful connections

        **Type:** boolean

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

        **Default:** 0

    **direct-logging-drp-rst**

        **Description** Configure PBSLB logging

        **Type:** boolean

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

        **Default:** 0

    **direct-pbslb-interval**

        **Description** Specify logging interval in minutes(default is 3)

        **Type:** number

        **Range:** 0-60

        **Default:** 3

    **direct-pbslb-logging**

        **Description** Configure PBSLB logging

        **Type:** boolean

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

        **Default:** 0

    **direct-service-group**

        **Description** Specify a service group (Specify the service group name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** direct-service-group and direct-action-value are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/slb/service-group <slb_service_group>`

    **dns64**

        **Description:** dns64 is a **JSON Block**.  Please see below for :ref:`3016_lid-list_dns64` 

        **Type:** Object

    **interval**

        **Description** Specify log interval in minutes, by default system will log every over limit instance

        **Type:** number

        **Range:** 1-255

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

    **over-limit-action**

        **Description** Set action when exceeds limit

        **Type:** boolean

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

        **Default:** 0

    **request-limit**

        **Description** Request limit (Specify request limit)

        **Type:** number

        **Range:** 1-1048575

    **request-per**

        **Description** Per (Specify interval in number of 100ms)

        **Type:** number

        **Range:** 1-65535

    **request-rate-limit**

        **Description** Request rate limit (Specify request rate limit)

        **Type:** number

        **Range:** 1-4294967295

    **response-code-rate-limit**

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

.. _3016_lid-list_dns64:

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

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

    **disable**

        **Description** Disable

        **Type:** boolean

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

        **Default:** 0

    **exclusive-answer**

        **Description** Exclusive Answer in DNS Response

        **Type:** boolean

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

        **Default:** 0

    **prefix**

        **Description** IPv6 prefix

        **Type:** string

        **Format:** ipv6-address-plen

.. _3016_lid-list_response-code-rate-limit:

lid-list_response-code-rate-limit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **code-range-end**

        **Description** server response code range end

        **Type:** number

        **Range:** 100-600

    **code-range-start**

        **Description** server response code range start

        **Type:** number

        **Range:** 100-600

    **period**

        **Description** seconds

        **Type:** number

        **Range:** 1-127

    **threshold**

        **Description** the times of getting the response code

        **Type:** number

        **Range:** 1-15