.. _health_monitor_method_database:

health monitor method database
==============================

DATABASE type


database Specification
----------------------

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

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

	 **Element Name**                      database

	 **Element URI**                       /axapi/v3/health/monitor/{name}/method/database

	 **Element Attributes**                database_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`database schema <health-monitor-method-database/health-monitor-method-database.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/monitor/{name}/method/database



.. raw:: html

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


:ref:`1835_database_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_monitor_method_database_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/monitor/{name}/method/database



.. raw:: html

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


:ref:`1835_database_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_monitor_method_database_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/monitor/{name}/method/database



.. raw:: html

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


:ref:`1835_database_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/monitor/{name}/method/database



.. raw:: html

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


:ref:`1835_database_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/health/monitor/{name}/method/database



.. raw:: html

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


:ref:`1835_database_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_monitor_method_database_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1835_database_attributes:

database attributes
-------------------

    **database**

        **Description** DATABASE type

        **Type:** boolean

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

        **Default:** 0

    **database-name**

        **Description** 'mssql': Specify MSSQL database; 'mysql': Specify MySQL database; 'oracle': Specify Oracle database; 'postgresql': Specify PostgreSQL database; 

        **Type:** string

        **Supported Values:** mssql, mysql, oracle, postgresql

    **db-column**

        **Description** Specify the column number for receiving

        **Type:** number

        **Range:** 1-10

    **db-column-integer**

        **Description** Specify the column number for receiving

        **Type:** number

        **Range:** 1-10

    **db-encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

    **db-name**

        **Description** Specify the database name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **db-password**

        **Description** Specify the user password

        **Type:** boolean

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

        **Default:** 0

    **db-password-str**

        **Description** Configure password

        **Type:** string

        **Format:** password

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **db-receive**

        **Description** Specify the response string

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** db-receive and db-receive-integer are mutually exclusive

    **db-receive-integer**

        **Description** Specify the response integer

        **Type:** number

        **Range:** 0-2147483647

        **Mutual Exclusion:** db-receive-integer and db-receive are mutually exclusive

    **db-row**

        **Description** Specify the row number for receiving

        **Type:** number

        **Range:** 1-10

    **db-row-integer**

        **Description** Specify the row number for receiving

        **Type:** number

        **Range:** 1-10

    **db-send**

        **Description** Specify the SQL query

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **db-username**

        **Description** Specify the username

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters