Документация BILLmanager 6

Резервное копирование (billmgr.backup)

billmgr.backup

Результат: список элементов

Резервное копирование

Уровень доступа: admin

ПараметрЗначение
idId
date Дата
size Размер, MiB

Запуск резервного копирования

Функция: billmgr.backup.create

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Скачать резервную копию на локальный компьютер

Функция: backups.download

Уровень доступа: admin

Восстановление

Функция: backups.restore

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
behavior Поведение. Выбор поведения при восстановлении существующих данных. "Пропустить существующие данные" означает, что сущности, которые есть в системе, не будут восстановлены. Также не будут восстановлены их зависимые элементы. "Изменить существующие данные" означает, что все данные из бэкапа будут восстановлены.

Например, в системе есть web домен, но файлы из его домашней директории были удалены. Если при восстановлении домена отметить "Пропустить существующие данные", то файлы не восстановятся. Если при восстановлении домена отметить "Изменить существующие данные", то файлы домена восстановятся, а также восстановятся и все настройки домена.

Добавить хранилище и план резервного копирования

Функция: billmgr.backup.setup

Уровень доступа: admin

Сохраненные данные

Функция: backupdata

Результат: список элементов

Уровень доступа: admin

ПараметрЗначение
type Тип данных

Содержимое

Функция: backupdata.names

Результат: список элементов

Уровень доступа: admin

ПараметрЗначение
name Имя данных
owner Владелец

Восстановление

Функция: backupdata.restore

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata).
    • elid — уникальный идентификатор (элемент id из функции backupdata.names)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata).
    • elid — уникальный идентификатор (элемент id из функции backupdata.names)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
version Версия. Выбрать дату резервной копии
behavior Поведение. Выбор поведения при восстановлении существующих данных. "Пропустить существующие данные" означает, что сущности, которые есть в системе, не будут восстановлены. Также не будут восстановлены их зависимые элементы. "Изменить существующие данные" означает, что все данные из бэкапа будут восстановлены.

Например, в системе есть web домен, но файлы из его домашней директории были удалены. Если при восстановлении домена отметить "Пропустить существующие данные", то файлы не восстановятся. Если при восстановлении домена отметить "Изменить существующие данные", то файлы домена восстановятся, а также восстановятся и все настройки домена.

Файлы

Функция: backupdata.files

Результат: список элементов

Уровень доступа: admin

ПараметрЗначение
dname Имя

Восстановление

Функция: backupdata.files.restore

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata.names).
    • elid — уникальный идентификатор (элемент name из функции backupdata.files)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata.names).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata.names).
    • elid — уникальный идентификатор (элемент name из функции backupdata.files)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
version Версия. Выбрать дату резервной копии

Закачать резервную копию

Функция: backups.upload

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
type Тип файла. Укажите, откуда вы хотите закачать файл: с локального компьютера или с использованием ссылки на файл, расположенный на другом сервере
url URL. Укажите ссылку на файл, который вы хотите закачать в текущий каталог, например, http://example.com/dir/file.html
name Имя файла. Укажите, с каким именем файл должен быть сохранён в текущем каталоге. Если вы оставите это поле пустым, имя файла будет выделено из URL
storage Хранилище. Выберите хранилище, в которое будет загружена резервная копия

Удаление резервной копии

Функция: backups.delete

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
clean_storages (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Нужно ли удалять архивы и листинги из хранилищ

Восстановление

Функция: billmgr.backup.settings

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
dropsettings (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Будут удалены настройки резервного копирования и информация о резервных копиях. Данные с хранилищ не удаляются