API: настройка бекапов — различия между версиями

Материал из BrainyCP
Перейти к: навигация, поиск
 
(не показано 18 промежуточных версий этого же участника)
Строка 30: Строка 30:
 
list_backup(post или get)* — константа, имя операции;
 
list_backup(post или get)* — константа, имя операции;
  
−
user_edit (post или get) — имя редактируемого пользователя;
+
user_edit (post или get) — Список заданий бекапов, для пользователя;
  
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
Строка 59: Строка 59:
 
list_backup(post или get)* — константа, имя операции;
 
list_backup(post или get)* — константа, имя операции;
  
−
user_edit (post или get) — имя редактируемого пользователя;
+
user_edit (post или get) — Список бекапов, для пользователя;
  
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
Строка 88: Строка 88:
 
add_backup (post или get)* — константа, имя операции;
 
add_backup (post или get)* — константа, имя операции;
  
−
remote_local (post или get)* — тип хранилища (2 значения: local,remote);
+
remote_local (post или get)* — тип хранилища (2 значения: local,remote,ftp,Dropbox);
 +
 
 +
local_path (post или get)* — по умолчанию (пусто).  
  
−
local_path (post или get)* — по умолчанию (пусто).   При выборе local:  
+
     При выборе local:  
  
−
                           local_path (post или get)* — по умолчанию (пусто).
+
            local_path (post или get)* — по умолчанию (/).
  
 
При выборе remote:
 
При выборе remote:
  
−
                             remoteip (post или get)* — удаленный сервер;                              remote_folder (post или get)* — удаленная папка;                             type_auth (post или get)* — тип аутентификации key, pass.   При выборе key:
+
            remoteip (post или get)* — удаленный сервер;
 +
 
 +
            remote_folder (post или get)* — удаленная папка;
 +
 
 +
            type_auth (post или get)* — тип аутентификации key, pass.  
 +
 
 +
            remote_port (post или get)* — удаленный порт, для ftp, ssh
 +
 
 +
    При выборе key:
 +
 
 +
             public_key (post)* —публичный ключ;
 +
 
 +
             private_key (post)* — приватный ключ.   При выборе pass:
 +
 
 +
             remote_login(post или get)* — удаленный логин;     
  
−
                             public_key (post)* —публичный ключ;                              private_key (post)* — приватный ключ.   При выборе pass:
+
             remote_pass (post или get)* — удаленный пароль (лучше передавать post).
  
−
                             remote_login(post или get)* — удаленный логин;                              remote_pass (post или get)* — удаленный пароль (лучше передавать post).
+
             remote_port (post или get)* — удаленный порт.
  
−
compression (post или get)* — 3 параметра на выбор (incr_noarch, tar, simple_noarch):   speed_limit (post или get)* — по умолчанию 0 (нет ограничений по скорости).   При выборе tar:    
+
token — Токен к удаленному хранилищу (по умолчанию пусто):
 +
 
 +
compression (post или get)* — 3 параметра на выбор (incr_noarch, tar, simple_noarch):  
 +
 
 +
maxcountbackups(post или get)* — количество копий бекапирования ( для tar, simple_noarch по умолчанию 0):
 +
 
 +
speed_limit (post или get)* — по умолчанию 0 (нет ограничений по скорости).   При выборе tar:    
  
 
                               level_compress (post или get)* — уровень компрессии от 0 до 9 по умолчанию;   period (post или get)* — 3 значения на выбор day, week, month:   При выборе week:
 
                               level_compress (post или get)* — уровень компрессии от 0 до 9 по умолчанию;   period (post или get)* — 3 значения на выбор day, week, month:   При выборе week:
Строка 108: Строка 130:
 
                             select_day (post или get)* — дни недели (например, 0,0,1,1,0,0,0,(пн,вт,ср, чт, пт, сб, вс).   При выборе month:
 
                             select_day (post или get)* — дни недели (например, 0,0,1,1,0,0,0,(пн,вт,ср, чт, пт, сб, вс).   При выборе month:
  
−
                             select_day (post или get)* — дни недели (например, 2,10,11,2 (число для каждого месяца);   time (post или get)* — время запуска backup пример 21-20-00 (часы, минуты, секунды);   active (post или get)* — принимает значение 1 или 0 по умолчанию неактивно;
+
                             select_day (post или get)* — дни недели (например, 2,10,11,2 (число для каждого месяца);
 +
 
 +
time (post или get)* — время запуска backup пример 21-20 (часы, минуты);  
 +
 
 +
active (post или get)* — принимает значение 1 или 0 по умолчанию неактивно;
 +
 
 +
encrypt_password(post или get)* — шифрует бекап, принимает значение пароля,по умолчанию неактивно.
 +
 
 +
list_email(post или get)* — отправка сообщения после бекапирования, принимает значение email, через запятую. По умолчанию неактивно;
  
 
all_user (post или get)*:
 
all_user (post или get)*:
  
−
                                       1 - все пользователи                                        user1, user2      (определенные пользователи).
+
         1 - все пользователи
  
−
user_edit (post или get) — имя редактируемого пользователя;
+
         user1, user2      (определенные пользователи).
  
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
Строка 167: Строка 197:
 
password (post или get)* — пароль пользователя;
 
password (post или get)* — пароль пользователя;
  
−
backup (post или get)* — константа, имя модуля;
+
config (post или get)* — имя конфига для удаления;
−
 
 
−
delete_jobs_backup (post или get)* — константа, имя операции;
 
−
 
 
−
delete_backup (post или get)* —  файл который нужно удалить ["taskconf"];
 
−
 
 
−
user_edit (post или get) — имя редактируемого пользователя;
 
  
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
Строка 202: Строка 226:
 
generate_key (post или get)* — константа, имя операции;
 
generate_key (post или get)* — константа, имя операции;
  
−
user_edit (post или get) — имя редактируемого пользователя;
+
name_conf (post или get) — имя конфига, из списка заданий;
  
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
Строка 209: Строка 233:
 
error:0, mess:'Успешно создано.'.detail[array_key];
 
error:0, mess:'Успешно создано.'.detail[array_key];
  
−
error:100, mess:'Массив ключей пустой'.
+
error:100, mess:'Ошибка сохранения ключа'.
 +
 
 +
error:118, mess:'Не указан файл конфиг'.
  
 
|-
 
|-
Строка 249: Строка 275:
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
username (post или get)* — имя пользователя;
 
username (post или get)* — имя пользователя;
 +
 +
edit_conf (post или get)* — имя конфига для редактирования;
  
 
password (post или get)* — пароль пользователя;
 
password (post или get)* — пароль пользователя;
Строка 254: Строка 282:
 
backup (post или get)* — константа, имя модуля;
 
backup (post или get)* — константа, имя модуля;
  
−
edit_backup (post или get)* — константа, имя операции;
+
add_backup (post или get)* — константа, имя операции;
 +
 
 +
remote_local (post или get)* — тип хранилища (2 значения: local,remote,ftp,Dropbox);
  
−
remote_local (post или get)* — тип хранилища (2 значения: local,remote);
+
local_path (post или get)* — по умолчанию (пусто).  
  
−
local_path (post или get)* — по умолчанию (пусто).   При выборе local:  
+
     При выборе local:  
  
−
                           local_path (post или get)* — по умолчанию (пусто).
+
            local_path (post или get)* — по умолчанию (/).
  
 
При выборе remote:
 
При выборе remote:
  
−
                             remoteip (post или get)* — удаленный сервер;                              remote_folder (post или get)* — удаленная папка;                             type_auth (post или get)* — тип аутентификации key, pass.   При выборе key:
+
            remoteip (post или get)* — удаленный сервер;
 +
 
 +
            remote_folder (post или get)* — удаленная папка;
 +
 
 +
            type_auth (post или get)* — тип аутентификации key, pass.  
 +
 
 +
            remote_port (post или get)* — удаленный порт, для ftp, ssh
 +
 
 +
    При выборе key:
 +
 
 +
             public_key (post)* —публичный ключ;
  
−
                             public_key (post)* —публичный ключ;                              private_key (post)* — приватный ключ.
+
             private_key (post)* — приватный ключ.   При выборе pass:
  
−
При выборе pass:
+
             remote_login(post или get)* — удаленный логин;     
  
−
                             remote_login(post или get)* — удаленный логин;                              remote_pass (post или get)* — удаленный пароль (лучше передавать post).
+
             remote_pass (post или get)* — удаленный пароль (лучше передавать post).
  
−
compression (post или get)* — 3 параметра на выбор (incr_noarch, tar, simple_noarch):   speed_limit (post или get)* — по умолчанию 0 (нет ограничений по скорости).   При выборе tar:    
+
             remote_port (post или get)* — удаленный порт.
 +
 
 +
token — Токен к удаленному хранилищу (по умолчанию пусто):
 +
 
 +
compression (post или get)* — 3 параметра на выбор (incr_noarch, tar, simple_noarch):  
 +
 
 +
maxcountbackups(post или get)* — количество копий бекапирования ( для tar, simple_noarch по умолчанию 0):
 +
 
 +
speed_limit (post или get)* — по умолчанию 0 (нет ограничений по скорости).   При выборе tar:    
  
 
                               level_compress (post или get)* — уровень компрессии от 0 до 9 по умолчанию;   period (post или get)* — 3 значения на выбор day, week, month:   При выборе week:
 
                               level_compress (post или get)* — уровень компрессии от 0 до 9 по умолчанию;   period (post или get)* — 3 значения на выбор day, week, month:   При выборе week:
Строка 278: Строка 326:
 
                             select_day (post или get)* — дни недели (например, 0,0,1,1,0,0,0,(пн,вт,ср, чт, пт, сб, вс).   При выборе month:
 
                             select_day (post или get)* — дни недели (например, 0,0,1,1,0,0,0,(пн,вт,ср, чт, пт, сб, вс).   При выборе month:
  
−
                             select_day (post или get)* — дни недели (например, 2,10,11,2 (число для каждого месяца);   time (post или get)* — время запуска backup пример 21-20-00 (часы, минуты, секунды);   active (post или get)* — принимает значение 1 или 0 по умолчанию неактивно;
+
                             select_day (post или get)* — дни недели (например, 2,10,11,2 (число для каждого месяца);
 +
 
 +
time (post или get)* — время запуска backup пример 21-20 (часы, минуты);  
 +
 
 +
active (post или get)* — принимает значение 1 или 0 по умолчанию неактивно;
 +
 
 +
encrypt_password(post или get)* — шифрует бекап, принимает значение пароля,по умолчанию неактивно.
 +
 
 +
list_email(post или get)* — отправка сообщения после бекапирования, принимает значение email, через запятую. По умолчанию неактивно;
  
 
all_user (post или get)*:
 
all_user (post или get)*:
  
−
                                       1 - все пользователи                                        user1, user2      (определенные пользователи).
+
         1 - все пользователи
  
−
user_edit (post или get) — имя редактируемого пользователя;
+
         user1, user2      (определенные пользователи).
  
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
Строка 333: Строка 389:
 
password (post или get)* — пароль пользователя;
 
password (post или get)* — пароль пользователя;
  
−
backup (post или get)* — константа, имя модуля;
+
config (post или get)* — имя конфига для бекапирования;
−
 
 
−
create_backup (post или get)* — константа, имя операции;
 
−
 
 
−
user_edit (post или get) — имя редактируемого пользователя;
 
  
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).

Текущая версия на 15:15, 10 июля 2020

 

Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.

Входящие данные, отмеченные звездочкой, обязательны для заполнения.

Модуль

Функция

Входящие данные

Варианты ошибок

backup

Вывод списка заданий бэкапов для пользователя.

list_jobs_backup

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

backup (post или get)* — константа, имя модуля;

list_backup(post или get)* — константа, имя операции;

user_edit (post или get) — Список заданий бекапов, для пользователя;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Вывод массива заданий',detail[array_list_job];

error:100, mess:'Заданий нет';

error:400, mess:'У вас недостаточно прав. Уберите user_edit'.

backup

Вывод списка бэкапов.

list_backup

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

backup (post или get)* — константа, имя модуля;

list_backup(post или get)* — константа, имя операции;

user_edit (post или get) — Список бекапов, для пользователя;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Список backup',detail[array_list_backup];

error:100, mess:'Список backup пуст';

error:400, mess:'У вас недостаточно прав. Уберите user_edit'.

backup

Создание нового задания бекапа.

add_backup

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

backup (post или get)* — константа, имя модуля;

add_backup (post или get)* — константа, имя операции;

remote_local (post или get)* — тип хранилища (2 значения: local,remote,ftp,Dropbox);

local_path (post или get)* — по умолчанию (пусто).  

     При выборе local:  

            local_path (post или get)* — по умолчанию (/).

При выборе remote:

            remoteip (post или get)* — удаленный сервер;

            remote_folder (post или get)* — удаленная папка;

            type_auth (post или get)* — тип аутентификации key, pass.  

            remote_port (post или get)* — удаленный порт, для ftp, ssh

    При выборе key:

             public_key (post)* —публичный ключ;

             private_key (post)* — приватный ключ.   При выборе pass:

             remote_login(post или get)* — удаленный логин;     

             remote_pass (post или get)* — удаленный пароль (лучше передавать post).

             remote_port (post или get)* — удаленный порт.

token — Токен к удаленному хранилищу (по умолчанию пусто):

compression (post или get)* — 3 параметра на выбор (incr_noarch, tar, simple_noarch):  

maxcountbackups(post или get)* — количество копий бекапирования ( для tar, simple_noarch по умолчанию 0):

speed_limit (post или get)* — по умолчанию 0 (нет ограничений по скорости).   При выборе tar:    

                               level_compress (post или get)* — уровень компрессии от 0 до 9 по умолчанию;   period (post или get)* — 3 значения на выбор day, week, month:   При выборе week:

                             select_day (post или get)* — дни недели (например, 0,0,1,1,0,0,0,(пн,вт,ср, чт, пт, сб, вс).   При выборе month:

                             select_day (post или get)* — дни недели (например, 2,10,11,2 (число для каждого месяца);

time (post или get)* — время запуска backup пример 21-20 (часы, минуты);  

active (post или get)* — принимает значение 1 или 0 по умолчанию неактивно;

encrypt_password(post или get)* — шифрует бекап, принимает значение пароля,по умолчанию неактивно.

list_email(post или get)* — отправка сообщения после бекапирования, принимает значение email, через запятую. По умолчанию неактивно;

all_user (post или get)*:

         1 - все пользователи

         user1, user2      (определенные пользователи).

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Добавлено удачно';

error:101, mess:'Хранилище указано не верно.',detail[array_list_story];

error:102, mess:'Не указан метод сжатия';

error:103, mess:'Неправильно указан уровень компрессии';

error:104, mess:'Некорректно указан период';

error:105, mess:'Некорректно указано время';

error:106, mess:'Некорректно указано количество дней';

error:107, mess:'Некорректно указаны дни месяцев';

error:108, mess:'Не указан ip удаленного сервера';

error:109, mess:'Не указана папка на удаленном сервере';

error:110, mess:'Неправильный тип аутентификации',detail[list_aunt];

error:111, mess:'Вы не указали публичный ключ';

error:112, mess:'Вы не указали приватный ключ';

error:113, mess:'Вы не указали удаленный логин';

error:114, mess:'Вы не указали удаленный пароль';

error:140, mess:'Некорректно указан пользователь',detail[list_users];

error:1000, mess:'Другая ошибка'.

backup

Удаление задания бекапа.

delete_jobs_backup

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

config (post или get)* — имя конфига для удаления;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Задача успешно удалена';

error:100, mess:'Выберите задачу которую нужно удалить';

error:1000, mess:'Ошибка удаления задачи'.

backup

Сгенерировать ключ.

generate_key

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

backup (post или get)* — константа, имя модуля;

generate_key (post или get)* — константа, имя операции;

name_conf (post или get) — имя конфига, из списка заданий;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Успешно создано.'.detail[array_key];

error:100, mess:'Ошибка сохранения ключа'.

error:118, mess:'Не указан файл конфиг'.

backup

История восстановления бекапов.

list_restore

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

backup (post или get)* — константа, имя модуля;

generate_key (post или get)* — константа, имя операции;

user_edit (post или get) — имя редактируемого пользователя;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Массив восстановления'.detail[array_list_restore];

error:100, mess:'Массив восстановления пустой'.

backup

Редактирование задания бекапа.

edit_backup

username (post или get)* — имя пользователя;

edit_conf (post или get)* — имя конфига для редактирования;

password (post или get)* — пароль пользователя;

backup (post или get)* — константа, имя модуля;

add_backup (post или get)* — константа, имя операции;

remote_local (post или get)* — тип хранилища (2 значения: local,remote,ftp,Dropbox);

local_path (post или get)* — по умолчанию (пусто).  

     При выборе local:  

            local_path (post или get)* — по умолчанию (/).

При выборе remote:

            remoteip (post или get)* — удаленный сервер;

            remote_folder (post или get)* — удаленная папка;

            type_auth (post или get)* — тип аутентификации key, pass.  

            remote_port (post или get)* — удаленный порт, для ftp, ssh

    При выборе key:

             public_key (post)* —публичный ключ;

             private_key (post)* — приватный ключ.   При выборе pass:

             remote_login(post или get)* — удаленный логин;     

             remote_pass (post или get)* — удаленный пароль (лучше передавать post).

             remote_port (post или get)* — удаленный порт.

token — Токен к удаленному хранилищу (по умолчанию пусто):

compression (post или get)* — 3 параметра на выбор (incr_noarch, tar, simple_noarch):  

maxcountbackups(post или get)* — количество копий бекапирования ( для tar, simple_noarch по умолчанию 0):

speed_limit (post или get)* — по умолчанию 0 (нет ограничений по скорости).   При выборе tar:    

                               level_compress (post или get)* — уровень компрессии от 0 до 9 по умолчанию;   period (post или get)* — 3 значения на выбор day, week, month:   При выборе week:

                             select_day (post или get)* — дни недели (например, 0,0,1,1,0,0,0,(пн,вт,ср, чт, пт, сб, вс).   При выборе month:

                             select_day (post или get)* — дни недели (например, 2,10,11,2 (число для каждого месяца);

time (post или get)* — время запуска backup пример 21-20 (часы, минуты);  

active (post или get)* — принимает значение 1 или 0 по умолчанию неактивно;

encrypt_password(post или get)* — шифрует бекап, принимает значение пароля,по умолчанию неактивно.

list_email(post или get)* — отправка сообщения после бекапирования, принимает значение email, через запятую. По умолчанию неактивно;

all_user (post или get)*:

         1 - все пользователи

         user1, user2      (определенные пользователи).

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Добавлено удачно';

error:101, mess:'Хранилище указано не верно.',detail[array_list_story];

error:102, mess:'Не указан метод сжатия';

error:103, mess:'Неправильно указан уровень компрессии';

error:104, mess:'Некорректно указан период';

error:105, mess:'Некорректно указано время';

error:106, mess:'Не корректно указано количество дней';

error:107, mess:'Некорректно указаны дни месяцев';

error:110, mess:'Неправильный тип аутентификации',detail[list_aunt];

error:111, mess:'Вы не указали публичный ключ';

error:112, mess:'Вы не указали приватный ключ';

error:113, mess:'Вы не указали удаленный логин';

error:114, mess:'Вы не указали удаленный пароль';

error:140, mess:'Некорректно указан пользователь',detail[list_users];

error:1000, mess:'Другая ошибка'.

backup

Запуск созданной задачи по бекапу.

create_backup

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

config (post или get)* — имя конфига для бекапирования;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Успешно создано';

error:100, mess:'Неправильно указан файл для запуска бекапа';

error:101, mess:'Превышено время выполнения скрипта';

error:1000, mess:'Ошибка выполнения скрипта'.

Другие полезные статьи:

API: подключение

API: мониторинг

API: статус веб-сервера

API: автоустановщик CMS

API: настройка бекапов

API: трансфер между серверами

API: антивирус

API: настройки сервера

API: управление веб-сервером

API: базы данных

API: пользовательские сертификаты

API: управление почтовыми ящиками

API: информация о сервере

API: почта

API: управление DNS-зонами

API: использование трафика

API: почтовые ящики клиента

API: установка веб-сервера

API: логирование

API: сервер имен

API: хост-аккаунты

API: менеджер приложений

API: сертификаты сервисов

API: CRON

API: менеджер процессов

API: сетевые инструменты

API: FTP-сервер

API: менеджер IP-адресов

API: средняя нагрузка

API: MySQL processlist

Источник — «https://docs.brainycp.com/index.php?title=API:_настройка_бекапов&oldid=785»