.. _ddos_zone_profile_port_range:

ddos zone-profile port-range
============================

DDOS Port-Range & Protocol profile configuration


port-range Specification
------------------------

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

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

	 **Object Key(s)**                     *port-range-start, port-range-end, protocol*

	 **Collection Name**                   :ref:`1235_port-range_list`

	 **Collection URI**                    /axapi/v3/ddos/zone-profile/{profile-name}/port-range

	                                       

	 **Element Name**                      port-range

	 **Element URI**                       /axapi/v3/ddos/zone-profile/{profile-name}/port-range/{port-range-start}+{port-range-end}+{protocol}

	 **Element Attributes**                port-range_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`port-range schema <ddos-zone-profile-port-range/ddos-zone-profile-port-range.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/ddos/zone-profile/{profile-name}/port-range



.. raw:: html

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


:ref:`1235_port-range_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/ddos/zone-profile/{profile-name}/port-range



.. raw:: html

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


:ref:`1235_port-range_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/ddos/zone-profile/{profile-name}/port-range/{port-range-start}+{port-range-end}+{protocol}



.. raw:: html

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


:ref:`1235_port-range_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/ddos/zone-profile/{profile-name}/port-range



.. raw:: html

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


:ref:`1235_port-range_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/ddos/zone-profile/{profile-name}/port-range/{port-range-start}+{port-range-end}+{protocol}



.. raw:: html

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


:ref:`1235_port-range_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/ddos/zone-profile/{profile-name}/port-range/{port-range-start}+{port-range-end}+{protocol}



.. raw:: html

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


:ref:`1235_port-range_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/ddos/zone-profile/{profile-name}/port-range



.. raw:: html

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


:ref:`1235_port-range_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/ddos/zone-profile/{profile-name}/port-range/{port-range-start}+{port-range-end}+{protocol}



.. raw:: html

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


:ref:`1235_port-range_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1235_port-range_list:

port-range-list
---------------


    port-range-list is **JSON List** of :ref:`1235_port-range_attributes` 

        port-range-list : [

             { :ref:`1235_port-range_attributes` },

             { :ref:`1235_port-range_attributes` },

             ...

         ]

.. _1235_port-range_attributes:

port-range attributes
---------------------

    **indicator-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-profile/{profile-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/indicator/{indicator-name} <ddos_zone_profile>`

    **port-range-end**

        **Description** Port-Range End Port Number

        **Type:** number

        **Range:** 2-65535

    **port-range-start**

        **Description** Port-Range Start Port Number

        **Type:** number

        **Range:** 1-65535

    **protocol**

        **Description** 'dns-tcp': DNS-TCP Port; 'dns-udp': DNS-UDP Port; 'http': HTTP Port; 'tcp': TCP Port; 'udp': UDP Port; 'ssl-l4': SSL-L4 Port; 'sip-tcp': SIP-TCP Port; 'sip-udp': SIP-UDP Port; 'quic': QUIC Port; 

        **Type:** string

        **Supported Values:** dns-tcp, dns-udp, http, tcp, udp, ssl-l4, sip-tcp, sip-udp, quic

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

.. _1235_indicator-list:

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

	 **Block object keys**             

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

    **indicator-name**

        **Description** 'pkt-rate': pkt-rate; 'pkt-drop-rate': pkt-drop-rate; 'bit-rate': bit-rate; 'pkt-drop-ratio': pkt-drop-ratio; 'bytes-to-bytes-from-ratio': bytes-to-bytes-from-ratio; 'concurrent-conns': concurrent-conns; 'conn-miss-rate': conn-miss-rate; 'syn-rate': syn-rate; 'fin-rate': fin-rate; 'rst-rate': rst-rate; 'small-window-ack-rate': small-window-ack-rate; 'empty-ack-rate': empty-ack-rate; 'small-payload-rate': small-payload-rate; 'syn-fin-ratio': syn-fin-ratio; 'cpu-utilization': cpu-utilization; 'interface-utilization': interface-utilization; 

        **Type:** string

        **Supported Values:** pkt-rate, pkt-drop-rate, bit-rate, pkt-drop-ratio, bytes-to-bytes-from-ratio, concurrent-conns, conn-miss-rate, syn-rate, fin-rate, rst-rate, small-window-ack-rate, empty-ack-rate, small-payload-rate, syn-fin-ratio, cpu-utilization, interface-utilization

    **src-threshold-cfg**

        **Description:** src-threshold-cfg is a **JSON Block**.  Please see below for :ref:`1235_indicator-list_src-threshold-cfg` 

        **Type:** Object

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

    **zone-threshold-cfg**

        **Description:** zone-threshold-cfg is a **JSON Block**.  Please see below for :ref:`1235_indicator-list_zone-threshold-cfg` 

        **Type:** Object

.. _1235_indicator-list_src-threshold-cfg:

indicator-list_src-threshold-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **src-threshold-large-num**

        **Description** Indicator per-src threshold

        **Type:** number

        **Range:** 1-10995116277760

    **src-threshold-num**

        **Description** Indicator per-src threshold

        **Type:** number

        **Range:** 1-2147483647

    **src-threshold-str**

        **Description** Indicator per-src threshold (Non-zero floating point)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _1235_indicator-list_zone-threshold-cfg:

indicator-list_zone-threshold-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **zone-threshold-large-num**

        **Description** Threshold for the entire zone

        **Type:** number

        **Range:** 1-10995116277760

    **zone-threshold-num**

        **Description** Threshold for the entire zone

        **Type:** number

        **Range:** 1-2147483647

    **zone-threshold-str**

        **Description** Threshold for the entire zone (Non-zero floating point)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters