.. _domain_group:

domain-group
============

Configure Domain group consisting of domain-lists


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

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

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

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

	 **Collection Name**                   :ref:`1443_domain-group_list`

	 **Collection URI**                    /axapi/v3/domain-group

	                                       

	 **Element Name**                      domain-group

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

	 **Element Attributes**                domain-group_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/domain-group/{name}/oper

	 **Schema**                             :download:`domain-group schema <domain-group/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/domain-group



.. raw:: html

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


:ref:`1443_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/domain-group



.. raw:: html

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


:ref:`1443_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/domain-group/{name}



.. raw:: html

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


:ref:`1443_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/domain-group



.. raw:: html

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


:ref:`1443_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/domain-group/{name}



.. raw:: html

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


:ref:`1443_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/domain-group/{name}



.. raw:: html

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


:ref:`1443_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/domain-group



.. raw:: html

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


:ref:`1443_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/domain-group/{name}



.. raw:: html

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


:ref:`1443_domain-group_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1443_domain-group_list:

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


    domain-group-list is **JSON List** of :ref:`1443_domain-group_attributes` 

        domain-group-list : [

             { :ref:`1443_domain-group_attributes` },

             { :ref:`1443_domain-group_attributes` },

             ...

         ]

.. _1443_domain-group_attributes:

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

    **domain-group-list**

        **Type:** List

    **domain-rate-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/domain-group/{name}/domain-rate/{dummy-name} <domain_group>`

    **name**

        **Description** Specify name of the domain group

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

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

.. _1443_domain-group-list:

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

	 **Block object keys**             

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

    **action**

        **Description** 'permit': permit; 'deny': deny; 

        **Type:** string

        **Supported Values:** permit, deny

        **Default:** permit

    **domain-list-name**

        **Description** Specify domain-list

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _1443_domain-rate-list:

domain-rate-list
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **domain-list-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/domain-group/{name}/domain-rate/{dummy-name}/domain-list/{name} <domain_group>`

    **dummy-name**

        **Description** 'configuration': Configure domain group rate limit; 

        **Type:** string

        **Supported Values:** configuration

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

.. _1443_domain-rate-list_domain-list-list:

domain-rate-list_domain-list-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **name**

        **Description** Specify name of the domain list

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **per-suffix-rate**

        **Description** Per suffix domain rate limit

        **Type:** number

        **Range:** 1-16000000

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