.. _ddos_dns_cache_domain_group:

ddos dns-cache domain-group
===========================

DNS Cache Settings


domain-group Specification
--------------------------

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

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

	 **Element Name**                      domain-group

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

	 **Element Attributes**                domain-group_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`domain-group schema <ddos-dns-cache-domain-group/ddos-dns-cache-domain-group.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/{name}/domain-group



.. raw:: html

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


:ref:`684_domain-group_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_domain_group_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/ddos/dns-cache/{name}/domain-group



.. raw:: html

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


:ref:`684_domain-group_attributes`



.. 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}/domain-group



.. raw:: html

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


:ref:`684_domain-group_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}/domain-group



.. raw:: html

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


:ref:`684_domain-group_attributes`



.. 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}/domain-group



.. raw:: html

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


:ref:`684_domain-group_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _684_domain-group_attributes:

domain-group attributes
-----------------------

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

.. _684_domain-list-policy-list:

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:`684_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

.. _684_domain-list-policy-list_packet-capturing:

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

.. _684_domain-list-policy-list_packet-capturing_root-zone-list:

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