Difference between revisions of "API: Logging"
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 17: | Line 13: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Show list of user logs. | |
show_log_list | show_log_list | ||
− | | 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">logging (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">show_log_list (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 the list of logs', detail;</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'The array of the list of logs is empty';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div> |
− | |||
− | password (post | ||
− | |||
− | logging (post | ||
− | |||
− | show_log_list (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:100, mess:' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 44: | Line 24: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | View log with incoming data. | |
show_log | show_log | ||
− | | 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">logging (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">show_log (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">path (post or get) * - path to the log file;</div> <div data-placeholder="Перевод" dir="ltr">from (post or get) - read from line number (default = 0);</div> <div data-placeholder="Перевод" dir="ltr">to (post or get) - read the number of lines (default = 200);</div> <div data-placeholder="Перевод" dir="ltr">search_string (post or get) * - search in the log (default =);</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: 'Reading the log file', detail: list_file_log;</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'The variable from or to is not a number';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'The log file is empty or not there';</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'Incorrect path specified.', detail: [array_list log];</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div> |
− | |||
− | password (post | ||
− | |||
− | logging (post | ||
− | |||
− | show_log (post | ||
− | |||
− | path (post | ||
− | |||
− | from (post | ||
− | |||
− | to (post | ||
− | |||
− | search_string (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:101, mess:' | ||
− | |||
− | error:100, mess:' | ||
− | |||
− | error:102, mess:' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|} | |} | ||
− | + | Other useful articles: | |
− | {| style="width: | + | {| style="width: 1055px;" |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]''' |
− | | | + | | style="width: 338px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]''' |
− | | | + | | style="width: 390px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]''' |
− | | | + | | style="width: 338px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]''' |
− | | | + | | style="width: 390px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]''' |
− | | | + | | style="width: 338px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]''' |
− | | | + | | style="width: 390px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]''' |
− | | | + | | style="width: 338px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]''' |
− | | | + | | style="width: 390px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]''' |
− | | | + | | style="width: 338px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]''' |
− | | | + | | style="width: 390px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]''' |
− | | | + | | style="width: 338px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]''' |
− | | | + | | style="width: 390px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]''' |
− | | | + | | style="width: 338px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]''' |
− | | | + | | style="width: 390px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]''' |
− | | | + | | style="width: 338px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]''' |
− | | | + | | style="width: 390px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]''' |
− | | | + | | style="width: 338px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]''' |
− | | | + | | style="width: 390px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]''' |
− | | | + | | style="width: 338px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]''' |
− | | | + | | style="width: 390px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]''' |
|} | |} | ||
| |
Latest revision as of 14:18, 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 |
logging |
Show list of user logs. show_log_list |
username (post or get) * - username; password (post or get) * - user password; logging (post or get) * - constant, module name; show_log_list (post or get) * - constant, operation name; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Array of the list of logs', detail; error: 100, mess: 'The array of the list of logs is empty'; error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.
|
logging |
View log with incoming data. show_log |
username (post or get) * - username; password (post or get) * - user password; logging (post or get) * - constant, module name; show_log (post or get) * - constant, operation name; path (post or get) * - path to the log file; from (post or get) - read from line number (default = 0); to (post or get) - read the number of lines (default = 200); search_string (post or get) * - search in the log (default =); language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Reading the log file', detail: list_file_log; error: 101, mess: 'The variable from or to is not a number'; error: 100, mess: 'The log file is empty or not there'; error: 102, mess: 'Incorrect path specified.', detail: [array_list log]; error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.
|
Other useful articles: