Difference between revisions of "API: Configuring backups"

From BrainyCP
Jump to: navigation, search
(Новая страница: « Администраторские функции требуют root-права API, чтобы использовать любой логин, размещен…»)
 
Line 1: Line 1:
 +
 +
 
  
 
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
 
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
Line 347: Line 349:
  
 
error:1000, mess:'Ошибка выполнения скрипта'.
 
error:1000, mess:'Ошибка выполнения скрипта'.
 +
 +
|}
 +
 +
Другие полезные статьи:
 +
 +
{| style="width: 1191px;"
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_подключение API: подключение]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_мониторинг API: мониторинг]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_статус_веб-сервера API: статус веб-сервера]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_автоустановщик_CMS API: автоустановщик CMS]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_настройка_бекапов API: настройка бекапов]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_трансфер_между_серверами API: трансфер между серверами]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_антивирус API: антивирус]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_настройки_сервера API: настройки сервера]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_управление_веб-сервером API: управление веб-сервером]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_базы_данных API: базы данных]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_пользовательские_сертификаты API: пользовательские сертификаты]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_управление_почтовыми_ящиками API: управление почтовыми ящиками]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_информация_о_сервере API: информация о сервере]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_почта API: почта]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_управление_DNS-зонами API: управление DNS-зонами]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_использование_трафика API: использование трафика]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_почтовые_ящики_клиента API: почтовые ящики клиента]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_установка_веб-сервера API: установка веб-сервера]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_логирование API: логирование]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_сервер_имен API: сервер имен]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_хост-аккаунты API: хост-аккаунты]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_менеджер_приложений API: менеджер приложений]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_сертификаты_сервисов API: сертификаты сервисов]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_CRON API: CRON]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_менеджер_процессов API: менеджер процессов]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_сетевые_инструменты API: сетевые инструменты]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_FTP-сервер API: FTP-сервер]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_менеджер_IP-адресов API: менеджер IP-адресов]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_средняя_нагрузка API: средняя нагрузка]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_MySQL_processlist API: MySQL processlist]'''
  
 
|}
 
|}

Revision as of 14:20, 31 January 2017

 

Администраторские функции требуют 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);

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:'Ошибка выполнения скрипта'.

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

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

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