.. _scaleout_debug_cluster:

scaleout debug cluster
======================

Display scaleout cluster info


cluster Specification
---------------------

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

	===================================== ===============================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      cluster

	 **Element URI**                       /axapi/v3/scaleout/debug/cluster

	 **Element Attributes**                cluster_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`cluster schema <scaleout-debug-cluster/scaleout-debug-cluster.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'>


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/scaleout/debug/cluster



.. raw:: html

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


cluster_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2621_cluster_attributes:

cluster attributes
------------------

    **database**

        **Description:** database is a **JSON Block**.  Please see below for :ref:`2621_database` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/scaleout/debug/cluster/database <scaleout_debug_cluster_database>`

    **status**

        **Description:** status is a **JSON Block**.  Please see below for :ref:`2621_status` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/scaleout/debug/cluster/status <scaleout_debug_cluster_status>`

.. _2621_status:

status
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2621_database:

database
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters