.. _slb_template_policy_forward_policy_action:

slb template policy forward-policy action
=========================================

action list


action Specification
--------------------

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

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

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

	 **Collection Name**                   :ref:`3018_action_list`

	 **Collection URI**                    /axapi/v3/slb/template/policy/{name}/forward-policy/action

	                                       

	 **Element Name**                      action

	 **Element URI**                       /axapi/v3/slb/template/policy/{name}/forward-policy/action/{name}

	 **Element Attributes**                action_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`action schema <slb-template-policy-forward-policy-action/slb-template-policy-forward-policy-action.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}/forward-policy/action



.. raw:: html

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


:ref:`3018_action_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/slb/template/policy/{name}/forward-policy/action



.. raw:: html

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


:ref:`3018_action_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/policy/{name}/forward-policy/action/{name}



.. raw:: html

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


:ref:`3018_action_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/slb/template/policy/{name}/forward-policy/action



.. raw:: html

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


:ref:`3018_action_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/policy/{name}/forward-policy/action/{name}



.. raw:: html

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


:ref:`3018_action_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}/forward-policy/action/{name}



.. raw:: html

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


:ref:`3018_action_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/slb/template/policy/{name}/forward-policy/action



.. raw:: html

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


:ref:`3018_action_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/policy/{name}/forward-policy/action/{name}



.. raw:: html

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


:ref:`3018_action_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3018_action_list:

action-list
-----------


    action-list is **JSON List** of :ref:`3018_action_attributes` 

        action-list : [

             { :ref:`3018_action_attributes` },

             { :ref:`3018_action_attributes` },

             ...

         ]

.. _3018_action_attributes:

action attributes
-----------------

    **action1**

        **Description** 'forward-to-internet': Forward request to Internet; 'forward-to-service-group': Forward request to service group; 'forward-to-proxy': Forward request to HTTP proxy server; 'drop': Drop request; 

        **Type:** string

        **Supported Values:** forward-to-internet, forward-to-service-group, forward-to-proxy, drop

    **drop-message**

        **Description** drop-message sent to the client as webpage(html tags are included and quotation marks are required for white spaces)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1023 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** drop-message and drop-redirect-url are mutually exclusive

    **drop-redirect-url**

        **Description** Specify URL to which client request is redirected upon being dropped

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1023 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** drop-redirect-url, drop-response-code, and drop-message are mutually exclusive

    **drop-response-code**

        **Description** Specify response code for drop action

        **Type:** number

        **Range:** 100-599

        **Mutual Exclusion:** drop-response-code and drop-redirect-url are mutually exclusive

    **fake-sg**

        **Description** service group to forward the packets to Internet

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **fall-back**

        **Description** Fallback service group for Internet

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **fall-back-snat**

        **Description** Source NAT pool or pool group for fallback server

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** fall-back-snat and fall-back-snat-pt-only are mutually exclusive

    **fall-back-snat-pt-only**

        **Description** Source port translation only for fallback server

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** fall-back-snat-pt-only and fall-back-snat are mutually exclusive

    **forward-snat**

        **Description** Source NAT pool or pool group

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** forward-snat and forward-snat-pt-only are mutually exclusive

    **forward-snat-pt-only**

        **Description** Source port translation only

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** forward-snat-pt-only and forward-snat are mutually exclusive

    **http-status-code**

        **Description** '301': Moved permanently; '302': Found; 

        **Type:** string

        **Supported Values:** 301, 302

        **Default:** 302

    **log**

        **Description** enable logging

        **Type:** boolean

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

        **Default:** 0

    **name**

        **Description** Action policy name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **proxy-chaining**

        **Description** Enable proxy chaining feature

        **Type:** boolean

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

        **Default:** 0

    **proxy-chaining-bypass**

        **Description** Forward all https packets to upstream proxy

        **Type:** boolean

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

        **Default:** 0

    **real-sg**

        **Description** service group to forward the packets

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **sampling-enable**

        **Type:** List

    **support-cert-fetch**

        **Description** Fetch server certificate by upstream proxy

        **Type:** boolean

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

        **Default:** 0

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

.. _3018_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'hits': Number of requests matching this destination rule; 

        **Type:** string

        **Supported Values:** all, hits