Difference between revisions of "API: CRON"

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>
−
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
 
−
 
 
−
Входящие данные, отмеченные звездочкой, обязательны для заполнения.
 
−
 
 
 
{| border="1" cellpadding="5"
 
{| border="1" cellpadding="5"
 
|-
 
|-
−
| <p dir="ltr" style="text-align: center;">'''Модуль'''</p>  
+
| <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">'''Module'''</div>  
−
| <p dir="ltr" style="text-align: center;">'''Функция'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Function'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Входящие данные'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Incoming data'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Варианты ошибок'''</p>  
+
| <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;" |  
−
Cписок CRON-заданий пользователя (ID, время, команда).
+
List of CRON-tasks of the user&nbsp;(ID, time, command).
  
 
listcommcron
 
listcommcron
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post)* — имя пользователя;
+
username (post)* — Username;
  
−
password (post)* — пароль пользователя;
+
password (post)* — User password;
  
−
crontab (post)* — константа, имя модуля;
+
crontab (post)* — constant, module name;
  
−
listcommcron (post)* — константа, тип операции;
+
listcommcron (post)* — constant, operation type;
  
−
language (post) — может принимать значение: en/ru (по умолчанию ru);
+
language (post) —can take a value: en/ru (by default ru);
  
−
panel_user (post) — имя пользователя ISP, к которому применяется операция.
+
panel_user (post) — ISP username, to which the operation is applied.
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Список задач cron был успешно получен для пользователя: <name>';
+
error:0, mess:'List opf cron tasks has been successfully received for the user: <name>';
  
−
error:1, mess:'Ничего не было найдено для:' <name>';
+
error:1, mess:'Nothing found for:' <name>';
  
−
error:1000, mess:'У вас нет прав администратора';
+
error:1000, mess:'You don't have admin rights';
  
−
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
+
error:1001, mess:'This&nbsp;user is not found in ISP-panel:<user>'.
  
 
|-
 
|-
Line 46: Line 42:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Добавление CRON-задания пользователю.
+
Adding CRON-task for user.
 +
 
 +
addcommcron
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post)* — имя пользователя;
+
username (post)* — Username;
  
−
password (post)* — пароль пользователя;
+
password (post)* — User password;
  
−
crontab (post)* — константа, имя модуля;
+
crontab (post)* — constant, module name;
  
−
addcommcron (post)* — константа, тип операции;
+
addcommcron (post)* — constant, operation type;
  
−
cron_freq_minutes (post)* — минуты в формате crond;
+
cron_freq_minutes (post)* — minutes in format crond;
  
−
cron_freq_hours (post)* — часы в формате crond;
+
cron_freq_hours (post)* — hours in format crond;
  
−
cron_freq_days (post)* — дни в формате crond;
+
cron_freq_days (post)* — days in format crond;
  
−
cron_freq_months (post)* — месяцы в формате crond;
+
cron_freq_months (post)* — months in format crond;
  
−
cron_freq_weekdays (post)* — выходные в формате crond;
+
cron_freq_weekdays (post)* — weekdays in format crond;
  
−
cron_command (post)* — команда для выполнения;
+
cron_command (post)* —command for launching;
  
−
language (post) — может принимать значение: en/ru (по умолчанию ru);
+
language (post) — can take a value: en/ru (by default ru);
  
−
panel_user (post) — имя пользователя ISP, к которому применяется операция.
+
panel_user (post) —ISP user name, to which the operation is applied.
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Новое задания crond было успешно добавлено для пользователя: <name>';
+
error:0, mess:'New task crond has been added for user: <name>';
  
−
error:5, mess:'Ошибка в блоке параметров';
+
error:5, mess:'Error in parameter block';
  
−
error:1, mess:'Ошибка добавления нового задания crond для пользователя: <name>';
+
error:1, mess:'Error in adding new task crond for user: <name>';
  
−
error:1000, mess:'У вас нет прав администратора';
+
error:1000, mess:'You don't have admin rights';
  
−
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
+
error:1001, mess:'The user is not found in ISP-panel:<user>'.
  
 
|-
 
|-
Line 89: Line 87:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Удаление CRON-задания.
+
Deleting&nbsp;CRON-task.
  
 
delcommcron
 
delcommcron
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post)* — имя пользователя;
+
username (post)* — Username;
−
 
 
−
password (post)* — пароль пользователя;
 
−
 
 
−
crontab (post)* — константа, имя модуля;
 
−
 
 
−
delcommcron (post)* — константа, тип операции;
 
−
 
 
−
cron_freq_minutes (post)* — минуты в формате crond;
 
−
 
 
−
cron_freq_hours (post)* — часы в формате crond;
 
  
−
cron_freq_days (post)* — дни в формате crond;
+
password (post)* — User password;
  
−
cron_freq_months (post)* — месяцы в формате crond;
+
crontab (post)* — constant, module name;
  
−
cron_freq_weekdays (post)* — выходные в формате crond;
+
delcommcron (post)* — constant, operation type;
  
−
cron_command (post)* — командя для выполнения;
+
id_command (post) * - Job id number (Array element number in the listcommcron method)
  
−
language (post) — может принимать значение: en/ru (по умолчанию ru);
+
language (post) — can take a value: en/ru (by default ru);
  
−
panel_user (post) — имя пользователя ISP, к которому применяется операция.
+
panel_user (post) — ISP username to which the operation is applied.
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Задача cron была кспешно удалена для пользователя: <name>';
+
error:0, mess:'Task cron has been deleted for user: <name>';
  
−
error:1, mess:'Ошибка удаления задания crond для пользователя: <name>';
+
error:1, mess:'Error in deleting task crond for user: <name>';
  
−
error:2, mess:'С такими параметрами задача cron не найдена для пользователя: <name>';
+
error:2, mess:'Task cron with such parameters is not found for user: <name>';
  
−
error:5, mess:'Ошибка в блоке параметров';
+
error:5, mess:'Error in parameter block';
  
−
error:1000, mess:'У вас нет прав администратора';
+
error:1000, mess:'You don't have admin rights';
  
−
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
+
error:1001, mess:'The user is not found in ISP-panel:<user>'.
  
 
|-
 
|-
Line 141: Line 129:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post)* — имя пользователя;
+
username (post)* — Username;
 +
 
 +
password (post)* — User password;
 +
 
 +
crontab (post)* — constant, module name;
 +
 
 +
editcommcron (post)* — constant, operation type;
 +
 
 +
cron_freq_minutes (post)* — minutes in format crond;
 +
 
 +
cron_freq_hours (post)* — hours in format crond;
 +
 
 +
cron_freq_days (post)* — days in format&nbsp;crond;
 +
 
 +
cron_freq_months (post)* — months in format&nbsp;crond;
 +
 
 +
cron_freq_weekdays (post)* — weekdays in format crond;
 +
 
 +
cron_command (post)* — command to perform;
 +
 
 +
id_command (post) * - Job id number (Array element number in the listcommcron method)
 +
 
 +
language (post) — can take a value: en/ru (by default ru);
 +
 
 +
panel_user (post) — ISP username to which the operation is applied.
 +
 
 +
| style="vertical-align: top;" |
 +
error:0, mess:'The crond task has been edited for user: <name>';
 +
 
 +
error:1, mess:'error in editing the current task&nbsp;crond for user: <name>';
 +
 
 +
error:2, mess:'The crond task with such parameters is not found for user:<username>';
 +
 
 +
error:4, mess:'No cron job with id ='
 +
 
 +
error:5, mess:'Error in parameter block';
 +
 
 +
error:1000, mess:'You don't have admin rights';
 +
 
 +
error:1001, mess:'The user is not found in ISP-panel:<user>'.
 +
 
 +
|}
 +
 
 +
Other useful articles:
 +
 
 +
{| style="width: 1108px;"
 +
|-
 +
| style="width: 346px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
 +
 
 +
| style="width: 333px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
 +
 
 +
| style="width: 407px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
 +
 
 +
|-
 +
| style="width: 346px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
 +
 
 +
| style="width: 333px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
 +
 
 +
| style="width: 407px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
−
password (post)* — пароль пользователя;
+
|-
 +
| style="width: 346px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
−
crontab (post)* — константа, имя модуля;
+
| style="width: 333px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
−
editcommcron (post)* — константа, тип операции;
+
| style="width: 407px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
−
cron_freq_minutes (post)* — минуты в формате crond;
+
|-
 +
| style="width: 346px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
−
cron_freq_hours (post)* — часы в формате crond;
+
| style="width: 333px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
−
cron_freq_days (post)* — дни в формате crond;
+
| style="width: 407px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
−
cron_freq_months (post)* — месяцы в формате crond;
+
|-
 +
| style="width: 346px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
−
cron_freq_weekdays (post)* — выходные в формате crond;
+
| style="width: 333px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
−
cron_command (post)* — командя для выполнения;
+
| style="width: 407px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
  
−
cron_new_minutes (post) — новые минуты в формате crond;
+
|-
 +
| style="width: 346px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
−
cron_new_hours (post) — новые часы в формате crond;
+
| style="width: 333px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
−
cron_freq_days (post)* — дни в формате crond;
+
| style="width: 407px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
−
cron_freq_months (post)* — месяцы в формате crond;
+
|-
 +
| style="width: 346px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
−
cron_freq_weekdays (post)* — выходные в формате crond;
+
| style="width: 333px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
−
cron_command (post)* — командя для выполнения;
+
| style="width: 407px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
−
language (post) — может принимать значение: en/ru (по умолчанию ru);
+
|-
 +
| style="width: 346px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
−
panel_user (post) — имя пользователя ISP, к которому применяется операция.
+
| style="width: 333px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
| style="width: 407px;" |  
−
error:0, mess:'Текущее задания crond было успешно отредактировано для пользователя: <name>';
+
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
−
error:1, mess:'Ошибка редактирования текущего задания crond для пользователя: <name>';
+
|-
 +
| style="width: 346px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
−
error:2, mess:'С такими значения задача crond не найдена для пользователя:<username>';
+
| style="width: 333px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
−
error:4, mess:'Не заданы новые значения. Нечего выполнять'
+
| style="width: 407px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
−
error:5, mess:'Ошибка в блоке параметров';
+
|-
 +
| style="width: 346px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
  
−
error:1000, mess:'У вас нет прав администратора';
+
| style="width: 333px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
−
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
+
| style="width: 407px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}

Latest revision as of 15:27, 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

crontab

List of CRON-tasks of the user (ID, time, command).

listcommcron

username (post)* — Username;

password (post)* — User password;

crontab (post)* — constant, module name;

listcommcron (post)* — constant, operation type;

language (post) —can take a value: en/ru (by default ru);

panel_user (post) — ISP username, to which the operation is applied.

error:0, mess:'List opf cron tasks has been successfully received for the user: <name>';

error:1, mess:'Nothing found for:' <name>';

error:1000, mess:'You don't have admin rights';

error:1001, mess:'This user is not found in ISP-panel:<user>'.

crontab

Adding CRON-task for user.

addcommcron

username (post)* — Username;

password (post)* — User password;

crontab (post)* — constant, module name;

addcommcron (post)* — constant, operation type;

cron_freq_minutes (post)* — minutes in format crond;

cron_freq_hours (post)* — hours in format crond;

cron_freq_days (post)* — days in format crond;

cron_freq_months (post)* — months in format crond;

cron_freq_weekdays (post)* — weekdays in format crond;

cron_command (post)* —command for launching;

language (post) — can take a value: en/ru (by default ru);

panel_user (post) —ISP user name, to which the operation is applied.

error:0, mess:'New task crond has been added for user: <name>';

error:5, mess:'Error in parameter block';

error:1, mess:'Error in adding new task crond for user: <name>';

error:1000, mess:'You don't have admin rights';

error:1001, mess:'The user is not found in ISP-panel:<user>'.

crontab

Deleting CRON-task.

delcommcron

username (post)* — Username;

password (post)* — User password;

crontab (post)* — constant, module name;

delcommcron (post)* — constant, operation type;

id_command (post) * - Job id number (Array element number in the listcommcron method)

language (post) — can take a value: en/ru (by default ru);

panel_user (post) — ISP username to which the operation is applied.

error:0, mess:'Task cron has been deleted for user: <name>';

error:1, mess:'Error in deleting task crond for user: <name>';

error:2, mess:'Task cron with such parameters is not found for user: <name>';

error:5, mess:'Error in parameter block';

error:1000, mess:'You don't have admin rights';

error:1001, mess:'The user is not found in ISP-panel:<user>'.

crontab

Редактирование CRON-задания.

editcommcron

username (post)* — Username;

password (post)* — User password;

crontab (post)* — constant, module name;

editcommcron (post)* — constant, operation type;

cron_freq_minutes (post)* — minutes in format crond;

cron_freq_hours (post)* — hours in format crond;

cron_freq_days (post)* — days in format crond;

cron_freq_months (post)* — months in format crond;

cron_freq_weekdays (post)* — weekdays in format crond;

cron_command (post)* — command to perform;

id_command (post) * - Job id number (Array element number in the listcommcron method)

language (post) — can take a value: en/ru (by default ru);

panel_user (post) — ISP username to which the operation is applied.

error:0, mess:'The crond task has been edited for user: <name>';

error:1, mess:'error in editing the current task crond for user: <name>';

error:2, mess:'The crond task with such parameters is not found for user:<username>';

error:4, mess:'No cron job with id ='

error:5, mess:'Error in parameter block';

error:1000, mess:'You don't have admin rights';

error:1001, mess:'The user is not found in ISP-panel:<user>'.

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:_CRON&oldid=1953"