.. _scaleout_cluster_device_groups_device_group:

scaleout cluster device-groups device-group
===========================================

Configure scaleout device groups


device-group Specification
--------------------------

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

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

	 **Object Key(s)**                     *device-group*

	 **Collection Name**                   :ref:`2598_device-group_list`

	 **Collection URI**                    /axapi/v3/scaleout/cluster/{cluster-id}/device-groups/device-group

	                                       

	 **Element Name**                      device-group

	 **Element URI**                       /axapi/v3/scaleout/cluster/{cluster-id}/device-groups/device-group/{device-group}

	 **Element Attributes**                device-group_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`device-group schema <scaleout-cluster-device-groups-device-group/scaleout-cluster-device-groups-device-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/scaleout/cluster/{cluster-id}/device-groups/device-group



.. raw:: html

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


:ref:`2598_device-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/scaleout/cluster/{cluster-id}/device-groups/device-group



.. raw:: html

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


:ref:`2598_device-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/scaleout/cluster/{cluster-id}/device-groups/device-group/{device-group}



.. raw:: html

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


:ref:`2598_device-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/scaleout/cluster/{cluster-id}/device-groups/device-group



.. raw:: html

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


:ref:`2598_device-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/scaleout/cluster/{cluster-id}/device-groups/device-group/{device-group}



.. raw:: html

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


:ref:`2598_device-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/scaleout/cluster/{cluster-id}/device-groups/device-group/{device-group}



.. raw:: html

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


:ref:`2598_device-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/scaleout/cluster/{cluster-id}/device-groups/device-group



.. raw:: html

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


:ref:`2598_device-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/scaleout/cluster/{cluster-id}/device-groups/device-group/{device-group}



.. raw:: html

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


:ref:`2598_device-group_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2598_device-group_list:

device-group-list
-----------------


    device-group-list is **JSON List** of :ref:`2598_device-group_attributes` 

        device-group-list : [

             { :ref:`2598_device-group_attributes` },

             { :ref:`2598_device-group_attributes` },

             ...

         ]

.. _2598_device-group_attributes:

device-group attributes
-----------------------

    **device-group**

        **Description** scaleout device group

        **Type:** number

        **Range:** 1-16

    **device-id-list**

        **Type:** List

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

.. _2598_device-id-list:

device-id-list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **device-id-end**

        **Description** 

        **Type:** number

    **device-id-start**

        **Description** 

        **Type:** number