Difference between revisions of "API: Monitoring"
From BrainyCP
(5 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | + | <div data-placeholder="Перевод" dir="ltr">Administrative functions require API root rights in order to use any login hosted on the server. If you do not have root rights, you can only use your login.</div> <div data-placeholder="Перевод" dir="ltr">Incoming data marked with an asterisk are required.</div> | |
− | |||
− | |||
− | |||
− | |||
{| border="1" cellpadding="5" | {| border="1" cellpadding="5" | ||
|- | |- | ||
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Module'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Function'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Incoming data'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Error variants'''</p> |
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 15: | Line 11: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Average load. | |
show_average_load | show_average_load | ||
− | | style="vertical-align: top;" | | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">monitor (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">show_average_load (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Average load statistics';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'No load average statistics'.</div> |
− | |||
− | password (post | ||
− | |||
− | monitor (post | ||
− | |||
− | show_average_load (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:100, mess:' | ||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 40: | Line 22: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Show storage space | |
show_storage_space | show_storage_space | ||
− | | style="vertical-align: top;" | | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">monitor (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">show_storage_space (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Array of disk space';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'The disk space array is empty'.</div> |
− | |||
− | password (post | ||
− | |||
− | monitor (post | ||
− | |||
− | show_storage_space (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:100, mess:' | ||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 65: | Line 33: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Show list of servers. | |
show_status | show_status | ||
− | | style="vertical-align: top;" | | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">monitor (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">show_status (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Array of services';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'The services array is empty'.</div> |
− | |||
− | password (post | ||
− | |||
− | monitor (post | ||
− | |||
− | show_status (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:100, mess:' | ||
− | |||
|} | |} | ||
− | + | Other useful articles: | |
− | {| style="width: | + | {| style="width: 993px;" |
|- | |- | ||
− | | | + | | style="width: 305px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]''' |
− | | | + | | style="width: 320px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]''' |
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 305px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]''' |
− | | | + | | style="width: 320px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]''' |
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 305px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]''' |
− | | | + | | style="width: 320px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]''' |
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 305px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]''' |
− | | | + | | style="width: 320px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]''' |
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 305px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]''' |
− | | | + | | style="width: 320px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]''' |
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 305px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]''' |
− | | | + | | style="width: 320px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]''' |
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 305px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]''' |
− | | | + | | style="width: 320px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]''' |
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 305px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]''' |
− | | | + | | style="width: 320px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]''' |
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 305px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]''' |
− | | | + | | style="width: 320px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]''' |
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 305px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]''' |
− | | | + | | style="width: 320px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]''' |
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]''' |
|} | |} |
Latest revision as of 14:23, 17 November 2021
Administrative functions require API root rights in order to use any login hosted on the server. If you do not have root rights, you can only use your login.
Incoming data marked with an asterisk are required.
Module |
Function |
Incoming data |
Error variants |
monitor |
Average load. show_average_load |
username (post or get) * - username; password (post or get) * - user password; monitor (post or get) * - constant, module name; show_average_load (post or get) * - constant, operation name; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Average load statistics'; error: 100, mess: 'No load average statistics'.
|
monitor |
Show storage space show_storage_space |
username (post or get) * - username; password (post or get) * - user password; monitor (post or get) * - constant, module name; show_storage_space (post or get) * - constant, operation name; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Array of disk space'; error: 100, mess: 'The disk space array is empty'.
|
monitor |
Show list of servers. show_status |
username (post or get) * - username; password (post or get) * - user password; monitor (post or get) * - constant, module name; show_status (post or get) * - constant, operation name; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Array of services'; error: 100, mess: 'The services array is empty'.
|
Other useful articles: