Difference between revisions of "API: Configuring backups"

Модуль

Функция

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

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

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);

local_path (post или get)* — по умолчанию (пусто).   При выборе local:  

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

При выборе remote:

                             remoteip (post или get)* — удаленный сервер;                              remote_folder (post или get)* — удаленная папка;                             type_auth (post или get)* — тип аутентификации key, pass.   При выборе key:

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

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

compression (post или get)* — 3 параметра на выбор (incr_noarch, tar, simple_noarch):   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-00 (часы, минуты, секунды);   active (post или get)* — принимает значение 1 или 0 по умолчанию неактивно;

all_user (post или get)*:

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

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

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)* — пароль пользователя;

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

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

delete_backup (post или get)* —  файл который нужно удалить ["taskconf"];

user_edit (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)* — константа, имя операции;

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

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

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

error:100, 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)* — имя пользователя;

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

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

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

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

local_path (post или get)* — по умолчанию (пусто).   При выборе local:  

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

При выборе remote:

                             remoteip (post или get)* — удаленный сервер;                              remote_folder (post или get)* — удаленная папка;                             type_auth (post или get)* — тип аутентификации key, pass.   При выборе key:

                             public_key (post)* —публичный ключ;                              private_key (post)* — приватный ключ.

При выборе pass:

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

compression (post или get)* — 3 параметра на выбор (incr_noarch, tar, simple_noarch):   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-00 (часы, минуты, секунды);   active (post или get)* — принимает значение 1 или 0 по умолчанию неактивно;

all_user (post или get)*:

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

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

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)* — пароль пользователя;

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

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

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

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

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

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

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

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