.. _ddos_dns_cache_sharded_domain_group:

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

DNS Sharded Domain Group


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

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

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

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

	 **Collection Name**                   :ref:`692_sharded-domain-group_list`

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

	                                       

	 **Element Name**                      sharded-domain-group

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

	 **Element Attributes**                sharded-domain-group_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`692_sharded-domain-group_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/dns-cache/{name}/sharded-domain-group



.. raw:: html

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


:ref:`692_sharded-domain-group_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}/sharded-domain-group/{name}



.. raw:: html

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


:ref:`692_sharded-domain-group_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/{name}/sharded-domain-group



.. raw:: html

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


:ref:`692_sharded-domain-group_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}/sharded-domain-group/{name}



.. raw:: html

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


:ref:`692_sharded-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}/sharded-domain-group/{name}



.. raw:: html

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


:ref:`692_sharded-domain-group_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/{name}/sharded-domain-group



.. raw:: html

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


:ref:`692_sharded-domain-group_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}/sharded-domain-group/{name}



.. raw:: html

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


:ref:`692_sharded-domain-group_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _692_sharded-domain-group_list:

sharded-domain-group-list
-------------------------


    sharded-domain-group-list is **JSON List** of :ref:`692_sharded-domain-group_attributes` 

        sharded-domain-group-list : [

             { :ref:`692_sharded-domain-group_attributes` },

             { :ref:`692_sharded-domain-group_attributes` },

             ...

         ]

.. _692_sharded-domain-group_attributes:

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

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

.. _692_sharded-domain-list-policy-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:`692_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

.. _692_sharded-domain-list-policy-list_packet-capturing:

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

.. _692_sharded-domain-list-policy-list_packet-capturing_root-zone-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