.. _scaleout_cluster_db_config:

scaleout cluster db-config
==========================

Configure zk prarameters


db-config Specification
-----------------------

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

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

	 **Element Name**                      db-config

	 **Element URI**                       /axapi/v3/scaleout/cluster/{cluster-id}/db-config

	 **Element Attributes**                db-config_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`db-config schema <scaleout-cluster-db-config/scaleout-cluster-db-config.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}/db-config



.. raw:: html

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


:ref:`2597_db-config_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}/db-config



.. raw:: html

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


:ref:`2597_db-config_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/scaleout/cluster/{cluster-id}/db-config



.. raw:: html

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


:ref:`2597_db-config_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}/db-config



.. raw:: html

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


:ref:`2597_db-config_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/scaleout/cluster/{cluster-id}/db-config



.. raw:: html

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


:ref:`2597_db-config_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2597_db-config_attributes:

db-config attributes
--------------------

    **broken-detect-timeout**

        **Description** database connection broken detection timeout (mseconds) (12000 mseconds for default)

        **Type:** number

        **Range:** 500-120000

        **Default:** 12000

    **client-recv-timeout**

        **Description** 

        **Type:** number

        **Range:** 50-100000

        **Default:** 13000

    **clientPort**

        **Description** client session port

        **Type:** number

        **Range:** 100-65535

    **elect-conn-timeout**

        **Description** election connection timeout (mseconds) (1200 for default)

        **Type:** number

        **Range:** 50-15000

        **Default:** 1200

    **initLimit**

        **Description** 

        **Type:** number

        **Range:** 1-500

    **loopback-intf-support**

        **Description** support loopback interface for scaleout database (enabled by default)

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 1

    **maxSessionTimeout**

        **Description** 

        **Type:** number

        **Range:** 50-100000

        **Default:** 30000

    **minSessionTimeout**

        **Description** 

        **Type:** number

        **Range:** 50-100000

        **Default:** 100

    **more-election-packet**

        **Description** send more election packet in election period (enabled by default)

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 1

    **syncLimit**

        **Description** 

        **Type:** number

        **Range:** 1-500

    **tickTime**

        **Description** 

        **Type:** number

        **Range:** 50-10000

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters