Difference between revisions of "API: Monitoring"

From BrainyCP
Jump to: navigation, search
(Новая страница: « Администраторские функции требуют root-права API, чтобы использовать любой логин, размещен…»)
 
 
(6 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"
 +
|-
 +
| <p dir="ltr" style="text-align: center;">'''Module'''</p>
 +
| <p dir="ltr" style="text-align: center;">'''Function'''</p>
 +
| <p dir="ltr" style="text-align: center;">'''Incoming data'''</p>
 +
| <p dir="ltr" style="text-align: center;">'''Error variants'''</p>
 +
|-
 +
| style="vertical-align: top;" |
 +
monitor
  
−
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
+
| style="vertical-align: top;" |
 +
Average load.
  
−
Входящие данные, отмеченные звездочкой, обязательны для заполнения.&nbsp;
+
show_average_load
  
−
{| border="1" cellpadding="5"
+
| 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>
 +
| 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>
 
|-
 
|-
−
| <p dir="ltr" style="text-align: center;">'''Модуль'''</p>  
+
| style="vertical-align: top;" |
−
| <p dir="ltr" style="text-align: center;">'''Функция'''</p>  
+
monitor
−
| <p dir="ltr" style="text-align: center;">'''Входящие данные'''</p>  
+
 
−
| <p dir="ltr" style="text-align: center;">'''Варианты ошибок'''</p>  
+
| style="vertical-align: top;" |
 +
Show storage space
 +
 
 +
show_storage_space
 +
 
 +
| 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>
 +
| 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>  
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 15: Line 33:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Средняя нагрузка.
+
Show list of servers.
  
−
show_average_load
+
show_status
 +
 
 +
| 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>
 +
| 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>
 +
|}
  
−
| style="vertical-align: top;" |
+
Other useful articles:
−
username (post или get)* — имя пользователя;
 
  
−
password (post или get)* — пароль пользователя;
+
{| style="width: 993px;"
 +
|-
 +
| style="width: 305px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
−
monitor (post или get)* — константа, имя модуля;
+
| style="width: 320px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
−
show_average_load (post или get)* — константа, имя операции;
+
| style="width: 346px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
+
|-
 +
| style="width: 305px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
| style="width: 320px;" |  
−
error:0, mess:'Статистика средней нагрузки';
+
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
−
error:100, mess:'Статистики средней нагрузки нет'.
+
| style="width: 346px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
 
|-
 
|-
−
| style="vertical-align: top;" |  
+
| style="width: 305px;" |  
−
monitor
+
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
 +
 
 +
| style="width: 320px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
 +
 
 +
| style="width: 346px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
|-
−
Вывод разделов по диску.
+
| style="width: 305px;" |  
 +
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
−
show_storage_space
+
| style="width: 320px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
| style="width: 346px;" |  
−
username (post или get)* — имя пользователя;
+
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
−
password (post или get)* — пароль пользователя;
+
|-
 +
| style="width: 305px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
−
monitor (post или get)* — константа, имя модуля;
+
| style="width: 320px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
−
show_storage_space (post или get)* — константа, имя операции;
+
| style="width: 346px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
+
|-
 +
| style="width: 305px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
| style="width: 320px;" |  
−
error:0, mess:'Массив дискового пространства';
+
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
−
error:100, mess:'Массив дискового пространства пуст'.
+
| style="width: 346px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
 
|-
 
|-
−
| style="vertical-align: top;" |  
+
| style="width: 305px;" |
−
monitor
+
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
 +
 
 +
| style="width: 320px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
 +
 
 +
| style="width: 346px;" |  
 +
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
|-
−
Вывод списка серверов.
+
| style="width: 305px;" |  
 +
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
−
show_status
+
| style="width: 320px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
| style="width: 346px;" |  
−
username (post или get)* — имя пользователя;
+
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
−
password (post или get)* — пароль пользователя;
+
|-
 +
| style="width: 305px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
−
monitor (post или get)* — константа, имя модуля;
+
| style="width: 320px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
−
show_status (post или get)* — константа, имя операции;
+
| style="width: 346px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
+
|-
 +
| style="width: 305px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
| style="width: 320px;" |  
−
error:0, mess:'Массив сервисов';
+
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
−
error:100, mess:'Массив сервисов пуст'.
+
| style="width: 346px;" |
 +
'''[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:

API: connection

API: monitoring

API: web server status

API: auto installer CMS

API: configuring backups

API: transfer between servers

API: antivirus

API: server settings

API: web server management

API: database

API: custom certificates

API: mailbox management

API: server information

API: mail

API: DNS zone management

API: traffic usage

API: client mailboxes

API: web server installation

API: logging

API: name server

API: host accounts

API: application manager

API: service certificates

API: CRON

API: process manager

API: network tools

API: FTP server

API: IP address manager

API: average load

API: MySQL processlist

Retrieved from "https://docs.brainycp.io/index.php?title=API:_Monitoring&oldid=1929"