.. _ddos_dst_zone_detection_outbound_detection_indicator:
ddos dst zone detection outbound-detection indicator
====================================================
Outbound indicator configuration
indicator Specification
-----------------------
===================================== ================================================================================================================
**Parameter** **Value**
===================================== ================================================================================================================
**Type** *Collection*
**Object Key(s)** *type*
**Collection Name** :ref:`834_indicator_list`
**Collection URI** /axapi/v3/ddos/dst/zone/{zone-name}/detection/outbound-detection/indicator
**Element Name** indicator
**Element URI** /axapi/v3/ddos/dst/zone/{zone-name}/detection/outbound-detection/indicator/{type}
**Element Attributes** indicator_attributes
**Partition Visibility** shared
**Schema** :download:`indicator schema <ddos-dst-zone-detection-outbound-detection-indicator/ddos-dst-zone-detection-outbound-detection-indicator.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/dst/zone/{zone-name}/detection/outbound-detection/indicator
.. raw:: html
</td><td valign = 'top'>
:ref:`834_indicator_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/dst/zone/{zone-name}/detection/outbound-detection/indicator
.. raw:: html
</td><td valign = 'top'>
:ref:`834_indicator_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/dst/zone/{zone-name}/detection/outbound-detection/indicator/{type}
.. raw:: html
</td><td valign = 'top'>
:ref:`834_indicator_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/dst/zone/{zone-name}/detection/outbound-detection/indicator
.. raw:: html
</td><td valign = 'top'>
:ref:`834_indicator_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/dst/zone/{zone-name}/detection/outbound-detection/indicator/{type}
.. raw:: html
</td><td valign = 'top'>
:ref:`834_indicator_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/dst/zone/{zone-name}/detection/outbound-detection/indicator/{type}
.. raw:: html
</td><td valign = 'top'>
:ref:`834_indicator_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/dst/zone/{zone-name}/detection/outbound-detection/indicator
.. raw:: html
</td><td valign = 'top'>
:ref:`834_indicator_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/dst/zone/{zone-name}/detection/outbound-detection/indicator/{type}
.. raw:: html
</td><td valign = 'top'>
:ref:`834_indicator_attributes`
.. raw:: html
</td><td></td></tr>
.. raw:: html
</table>
.. _834_indicator_list:
indicator-list
--------------
indicator-list is **JSON List** of :ref:`834_indicator_attributes`
indicator-list : [
{ :ref:`834_indicator_attributes` },
{ :ref:`834_indicator_attributes` },
...
]
.. _834_indicator_attributes:
indicator attributes
--------------------
**data-packet-size**
**Description** Expected minimal data size
**Type:** number
**Range:** 1-1500
**tcp-window-size**
**Description** Expected minimal window size
**Type:** number
**Range:** 1-500
**threshold-large-num**
**Description** Threshold for each geo-location
**Type:** number
**Range:** 1-10995116277760
**threshold-num**
**Description** Threshold for each geo-location
**Type:** number
**Range:** 1-2147483647
**threshold-str**
**Description** Threshold for each geo-location (Non-zero floating point)
**Type:** string
**Maximum Length:** 128 characters
**Maximum Length:** 1 characters
**type**
**Description** 'pkt-rate': rate of incoming packets; 'pkt-drop-rate': rate of packets got dropped; 'bit-rate': rate of incoming bits; 'pkt-drop-ratio': ratio of incoming packet rate divided by the rate of dropping packets; 'bytes-to-bytes-from-ratio': ratio of incoming packet rate divided by the rate of outgoing packets; 'syn-rate': rate on incoming SYN packets; 'fin-rate': rate on incoming FIN packets; 'rst-rate': rate of incoming RST packets; 'small-window-ack-rate': rate of small window advertisement; 'empty-ack-rate': rate of incoming packets which have no payload; 'small-payload-rate': rate of short payload packet; 'syn-fin-ratio': ratio of incoming SYN packet rate divided by the rate of incoming FIN packets;
**Type:** string
**Supported Values:** pkt-rate, pkt-drop-rate, bit-rate, pkt-drop-ratio, bytes-to-bytes-from-ratio, syn-rate, fin-rate, rst-rate, small-window-ack-rate, empty-ack-rate, small-payload-rate, syn-fin-ratio
**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