.. _ddos_dns_cache:

ddos dns-cache
==============

DNS Cache Settings


dns-cache Specification
-----------------------

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

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

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

	 **Collection Name**                   :ref:`697_dns-cache_list`

	 **Collection URI**                    /axapi/v3/ddos/dns-cache

	                                       

	 **Element Name**                      dns-cache

	 **Element URI**                       /axapi/v3/ddos/dns-cache/{name}

	 **Element Attributes**                dns-cache_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/ddos/dns-cache/{name}/stats

	 **Operational Data URI**              /axapi/v3/ddos/dns-cache/{name}/oper

	 **Schema**                             :download:`dns-cache schema <ddos-dns-cache/ddos-dns-cache.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/dns-cache



.. raw:: html

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


:ref:`697_dns-cache_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/ddos_dns_cache_POST.txt
   :literal:




.. raw:: html

   </div></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/dns-cache



.. raw:: html

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


:ref:`697_dns-cache_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/dns-cache/{name}



.. raw:: html

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


:ref:`697_dns-cache_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/dns-cache



.. raw:: html

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


:ref:`697_dns-cache_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/dns-cache/{name}



.. raw:: html

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


:ref:`697_dns-cache_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/dns-cache/{name}



.. raw:: html

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


:ref:`697_dns-cache_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/dns-cache



.. raw:: html

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


:ref:`697_dns-cache_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/dns-cache/{name}



.. raw:: html

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


:ref:`697_dns-cache_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _697_dns-cache_list:

dns-cache-list
--------------


    dns-cache-list is **JSON List** of :ref:`697_dns-cache_attributes` 

        dns-cache-list : [

             { :ref:`697_dns-cache_attributes` },

             { :ref:`697_dns-cache_attributes` },

             ...

         ]

.. _697_dns-cache_attributes:

dns-cache attributes
--------------------

    **any-query-action-str**

        **Description** 'respond-refuse': Send refuse response (default); 'respond-empty': Send empty response; 'drop': Drop the request; 

        **Type:** string

        **Supported Values:** respond-refuse, respond-empty, drop

        **Default:** respond-refuse

    **default-serving-action**

        **Description** 'serve-from-cache': Serve DNS records; 'forward': Forward to DNS server; 'drop': Drop the request; 

        **Type:** string

        **Supported Values:** serve-from-cache, forward, drop

        **Default:** serve-from-cache

    **domain-group**

        **Description:** domain-group is a **JSON Block**.  Please see below for :ref:`697_domain-group` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/dns-cache/{name}/domain-group <ddos_dns_cache>`

    **fqdn-manual-override-action-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dns-cache/{name}/fqdn-manual-override-action/{fqdn-name} <ddos_dns_cache>`

    **name**

        **Description** DNS Cache Instance Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **neg-cache-action-follow-q-rate**

        **Description** Negative cached response queries counted toward query-rate-threshold

        **Type:** boolean

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

        **Default:** 0

    **non-authoritative-zone-query-action-str**

        **Description** 'default': Default action: respond-refuse; 'forward': Forward to DNS server; 'respond-refuse': Send refuse response; 'drop': Drop the request; 

        **Type:** string

        **Supported Values:** default, forward, respond-refuse, drop

        **Default:** respond-refuse

    **sampling-enable**

        **Type:** List

    **sharded-domain-group-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dns-cache/{name}/sharded-domain-group/{name} <ddos_dns_cache>`

    **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-domain-lookup-miss-action**

        **Description** 'respond-nxdomain': Send NxDomain response; 'drop': Drop the request; 

        **Type:** string

        **Supported Values:** respond-nxdomain, drop

        **Default:** respond-nxdomain

    **zone-manual-override-action-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dns-cache/{name}/zone-manual-override-action/{zone-name} <ddos_dns_cache>`

    **zone-transfer**

        **Description:** zone-transfer is a **JSON Block**.  Please see below for :ref:`697_zone-transfer` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/dns-cache/{name}/zone-transfer <ddos_dns_cache>`

.. _697_domain-group:

domain-group
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **domain-list-policy-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dns-cache/{name}/domain-group/domain-list-policy/{name} <ddos_dns_cache>`

    **name**

        **Description** DNS domain group

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

.. _697_domain-group_domain-list-policy-list:

domain-group_domain-list-policy-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **cache-all-records**

        **Description** cache all fqdn records including uncommon types

        **Type:** boolean

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

        **Default:** 0

    **client-ipv4**

        **Description** Client ipv4 address

        **Type:** string

        **Format:** ipv4-address

    **client-ipv6**

        **Description** Client ipv6 address

        **Type:** string

        **Format:** ipv6-address

    **force**

        **Description** Force update even the serial is the same

        **Type:** boolean

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

        **Default:** 0

    **manual-refresh**

        **Description** Manually refresh the particular zone

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 253 characters

        **Maximum Length:** 1 characters

    **name**

        **Description** DNS domain list policy

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **oversize-answer-response**

        **Description** 'set-truncate-bit': Set the TC bit for oversize answer(default); 'disable-truncate-bit': Do not set TC bit for oversize answer; 

        **Type:** string

        **Supported Values:** set-truncate-bit, disable-truncate-bit

        **Default:** set-truncate-bit

    **packet-capturing**

        **Description:** packet-capturing is a **JSON Block**.  Please see below for :ref:`697_domain-group_domain-list-policy-list_packet-capturing` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/dns-cache/{name}/domain-group/domain-list-policy/{name}/packet-capturing <ddos_dns_cache>`

    **refresh-interval-hours**

        **Description** Zone transfer refresh rate in hours (Default 4). 0 means no refresh

        **Type:** number

        **Range:** 0-24

        **Default:** 4

    **resolve-cname-record**

        **Description** Always try to resolve domain in CNAME record answer section

        **Type:** boolean

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

        **Default:** 0

    **respond-with-authority**

        **Description** Respond with authority section for all requests under this list

        **Type:** boolean

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

        **Default:** 0

    **server-ipv4**

        **Description** Master ipv4 address

        **Type:** string

        **Format:** ipv4-address

    **server-ipv6**

        **Description** Master ipv6 address

        **Type:** string

        **Format:** ipv6-address

    **server-v4-port**

        **Description** Port number (default 53)

        **Type:** number

        **Range:** 1-65535

        **Default:** 53

    **server-v6-port**

        **Description** Port number (default 53)

        **Type:** number

        **Range:** 1-65535

        **Default:** 53

    **ttl-override**

        **Description** Override the TTL value for zone transfer

        **Type:** number

        **Range:** 1-2147483647

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

.. _697_domain-group_domain-list-policy-list_packet-capturing:

domain-group_domain-list-policy-list_packet-capturing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **root-zone-list**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _697_domain-group_domain-list-policy-list_packet-capturing_root-zone-list:

domain-group_domain-list-policy-list_packet-capturing_root-zone-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **capture-config**

        **Description** Capture-config name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/capture-config <capture_config>`

    **capture-mode**

        **Description** 'regular': Capture packet anyway; 'capture-on-failure': Capture packet if last XFR was failed; 

        **Type:** string

        **Supported Values:** regular, capture-on-failure

    **root-zone**

        **Description** Specify root zone to be captured

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 253 characters

        **Maximum Length:** 1 characters

.. _697_fqdn-manual-override-action-list:

fqdn-manual-override-action-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action**

        **Description** 'default': Default; 'forward': Forward to DNS server; 'drop': Drop the request; 'serve-from-cache': Serve DNS records; 

        **Type:** string

        **Supported Values:** default, forward, drop, serve-from-cache

    **fqdn-name**

        **Description** Specify fqdn name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 253 characters

        **Maximum Length:** 1 characters

.. _697_zone-transfer:

zone-transfer
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _697_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'total-cached-fqdn': total-cached-fqdn; 'total-cached-records': total-cached-records; 'fqdn-a': fqdn-a; 'fqdn-aaaa': fqdn-aaaa; 'fqdn-cname': fqdn-cname; 'fqdn-ns': fqdn-ns; 'fqdn-mx': fqdn-mx; 'fqdn-soa': fqdn-soa; 'fqdn-srv': fqdn-srv; 'fqdn-txt': fqdn-txt; 'fqdn-ptr': fqdn-ptr; 'fqdn-other': fqdn-other; 'fqdn-wildcard': fqdn-wildcard; 'fqdn-delegation': fqdn-delegation; 'shard-size': shard-size; 'resp-ext-size': resp-ext-size; 'a-record': a-record; 'aaaa-record': aaaa-record; 'cname-record': cname-record; 'ns-record': ns-record; 'mx-record': mx-record; 'soa-record': soa-record; 'srv-record': srv-record; 'txt-record': txt-record; 'ptr-record': ptr-record; 'other-record': other-record; 'fqdn-in-shard-filter': fqdn-in-shard-filter; 

        **Type:** string

        **Supported Values:** all, total-cached-fqdn, total-cached-records, fqdn-a, fqdn-aaaa, fqdn-cname, fqdn-ns, fqdn-mx, fqdn-soa, fqdn-srv, fqdn-txt, fqdn-ptr, fqdn-other, fqdn-wildcard, fqdn-delegation, shard-size, resp-ext-size, a-record, aaaa-record, cname-record, ns-record, mx-record, soa-record, srv-record, txt-record, ptr-record, other-record, fqdn-in-shard-filter

.. _697_zone-manual-override-action-list:

zone-manual-override-action-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action**

        **Description** 'default': Default; 'forward': Forward to DNS server; 'drop': Drop the request; 'serve-from-cache': Serve DNS records; 

        **Type:** string

        **Supported Values:** default, forward, drop, serve-from-cache

    **zone-name**

        **Description** Specify zone name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 253 characters

        **Maximum Length:** 1 characters

.. _697_sharded-domain-group-list:

sharded-domain-group-list
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **encap-template**

        **Description** DDOS encap template to sepcify the tunnel endpoint

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **match-action**

        **Description** 'forward': Forward query to server (default); 'tunnel-encap': Encapsulate the query and send on a tunnel; 

        **Type:** string

        **Supported Values:** forward, tunnel-encap

        **Default:** forward

    **name**

        **Description** DNS sharded domain group

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **sharded-domain-list-policy-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dns-cache/{name}/sharded-domain-group/{name}/sharded-domain-list-policy/{name} <ddos_dns_cache>`

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

.. _697_sharded-domain-group-list_sharded-domain-list-policy-list:

sharded-domain-group-list_sharded-domain-list-policy-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **client-ipv4**

        **Description** Client ipv4 address

        **Type:** string

        **Format:** ipv4-address

    **client-ipv6**

        **Description** Client ipv6 address

        **Type:** string

        **Format:** ipv6-address

    **force**

        **Description** Force update even the serial is the same

        **Type:** boolean

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

        **Default:** 0

    **manual-refresh**

        **Description** Manually refresh the particular zone

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 253 characters

        **Maximum Length:** 1 characters

    **name**

        **Description** DNS sharded domain list policy

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **packet-capturing**

        **Description:** packet-capturing is a **JSON Block**.  Please see below for :ref:`697_sharded-domain-group-list_sharded-domain-list-policy-list_packet-capturing` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/dns-cache/{name}/sharded-domain-group/{name}/sharded-domain-list-policy/{name}/packet-capturing <ddos_dns_cache>`

    **refresh-interval-hours**

        **Description** Zone transfer refresh rate in hours (Default 4). 0 means no refresh

        **Type:** number

        **Range:** 0-24

        **Default:** 4

    **server-ipv4**

        **Description** Master ipv4 address

        **Type:** string

        **Format:** ipv4-address

    **server-ipv6**

        **Description** Master ipv6 address

        **Type:** string

        **Format:** ipv6-address

    **server-v4-port**

        **Description** Port number (default 53)

        **Type:** number

        **Range:** 1-65535

        **Default:** 53

    **server-v6-port**

        **Description** Port number (default 53)

        **Type:** number

        **Range:** 1-65535

        **Default:** 53

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

.. _697_sharded-domain-group-list_sharded-domain-list-policy-list_packet-capturing:

sharded-domain-group-list_sharded-domain-list-policy-list_packet-capturing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **root-zone-list**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _697_sharded-domain-group-list_sharded-domain-list-policy-list_packet-capturing_root-zone-list:

sharded-domain-group-list_sharded-domain-list-policy-list_packet-capturing_root-zone-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **capture-config**

        **Description** Capture-config name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/capture-config <capture_config>`

    **capture-mode**

        **Description** 'regular': Capture packet anyway; 'capture-on-failure': Capture packet if last XFR was failed; 

        **Type:** string

        **Supported Values:** regular, capture-on-failure

    **root-zone**

        **Description** Specify root zone to be captured

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 253 characters

        **Maximum Length:** 1 characters