.. _health_global:

health global
=============

Define the Health Monitor global default


global Specification
--------------------

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

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

	 **Element Name**                      global

	 **Element URI**                       /axapi/v3/health/global

	 **Element Attributes**                global_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`global schema <health-global/health-global.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/health/global



.. raw:: html

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


:ref:`1832_global_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/health_global_POST.txt
   :literal:




.. raw:: html

   </div></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/health/global



.. raw:: html

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


:ref:`1832_global_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/health_global_GET.txt
   :literal:




.. raw:: html

   </div></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/health/global



.. raw:: html

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


:ref:`1832_global_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/health/global



.. raw:: html

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


:ref:`1832_global_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/health_global_PUT.txt
   :literal:




.. raw:: html

   </div></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/health/global



.. raw:: html

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


:ref:`1832_global_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/health_global_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1832_global_attributes:

global attributes
-----------------

    **check-rate**

        **Description** Health Check Rate per 500ms (default 1000)

        **Type:** number

        **Range:** 1-50000

        **Default:** 1000

    **disable-auto-adjust**

        **Description** Disable the Health Check Rate Auto Adjustment

        **Type:** boolean

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

        **Default:** 0

    **external-rate**

        **Description** Define the External Health Check Rate (Number of External Script Programs (default 2))

        **Type:** number

        **Range:** 1-999

        **Default:** 2

    **interval**

        **Description** Specify the Healthcheck Interval (Interval Value, in seconds (default 5))

        **Type:** number

        **Range:** 1-180

        **Default:** 5

    **multi-process**

        **Description** Start Health Monitoring in Multi-Process Mode (Specify the number of multiple processes (default 1))

        **Type:** number

        **Range:** 1-20

        **Default:** 1

    **per**

        **Description** Specify the Unit Time for the rate (Specify the Unit Time, multiple of 100ms)

        **Type:** number

        **Range:** 1-20

        **Default:** 2

    **retry**

        **Description** Specify the Healthcheck Retries (Retry Count (default 3))

        **Type:** number

        **Range:** 1-10

        **Default:** 3

    **timeout**

        **Description** Specify the Healthcheck Timeout (Timeout Value, in seconds (default 5), Timeout should be less than or equal to interval)

        **Type:** number

        **Range:** 1-180

        **Default:** 5

    **up-retry**

        **Description** Specify the Healthcheck Retries before declaring target up (Up-retry count (default 1))

        **Type:** number

        **Range:** 1-10

        **Default:** 1

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters