Группа методов Backup внешнего программного интерфейса Менеджера сервиса предназначена для управления архивными копиями приложений абонента.
Для создания новых архивных копий следует использовать метод tenant/backup/create.
Сводка по методам
Метод | Примечание |
---|---|
root | |
Возвращает список архивных копий, доступных пользователю. | |
Возвращает информацию об указанной архивной копии. | |
Создает задание на восстановление указанной архивной копии в новую область. | |
Удаляет указанную архивную копию. | |
Получить талон на скачивание файла архивной копии абонента |
backup/list
Метод возвращает список архивных копий указанного приложения. Поиск приложения выполняется по номеру области данных.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
tenant * | Число | Номер области |
start_date * | Дата и время в строке формата ISO | Выводить сведения о резервных копиях с датой создания не ранее start_date |
end_date * | Дата и время в строке формата ISO | Выводить сведения о резервных копиях с датой создания не позднее end_date |
Ответ: backup (0..*) | ||
id | Строка | Идентификатор резервной копии. |
tenant | Число | Номер области. |
application | Строка | Код вида приложения. |
app_version | Строка | Версия конфигурации. |
app_name | Строка | Наименование вида приложения. |
timestamp | Дата | Момент создания резервной копии (часовой пояс области). |
utc_timestamp | Дата | Момент создания резервной копии (универсальное время). |
timezone | Строка | Часовой пояс области. |
is_daily | Булево | Это ежедневная резервная копия. |
is_monthly | Булево | Это ежемесячная резервная копия. |
is_annual | Булево | Это ежегодная резервная копия. |
is_ondemand | Булево | Это резервная копия по требованию. |
is_original | Булево | Это исходный (самый первый) образ области. |
comment | Строка | Комментарий к архивной копии. |
backup/info
Метод возвращает информацию об указанной архивной копии. Поиск архивной копии выполняется по идентификатору.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Строка | Идентификатор резервной копии. |
Ответ: backup (1) | ||
id | Строка | Идентификатор резервной копии. |
tenant | Число | Номер области. |
application | Строка | Код вида приложения. |
app_name | Строка | Наименование вида приложения. |
app_version | Строка | Версия конфигурации. |
timestamp | Дата | Момент создания резервной копии (часовой пояс области). |
utc_timestamp | Дата | Момент создания резервной копии (универсальное время). |
timezone | Строка | Часовой пояс области. |
is_daily | Булево | Это ежедневная резервная копия. |
is_monthly | Булево | Это ежемесячная резервная копия. |
is_annual | Булево | Это ежегодная резервная копия. |
is_ondemand | Булево | Это резервная копия по требованию. |
is_original | Булево | Это исходный (самый первый) образ области. |
comment | Строка | Комментарий к архивной копии. |
backup/restore
Метод создает задание на восстановление указанной архивной копии в новую область данных. Выполнение метода равноценно выполнению команд "Архивирование - Восстановить приложение" в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Строка | Идентификатор резервной копии. |
name * | Строка | Наименование нового приложения. |
timezone * | Строка | Часовой пояс нового приложения. |
Ответ: tenant (1) | ||
id | Число | Номер созданной при восстановлении новой области. |
name | Строка | Название области. |
owner | Число | Код абонента-владельца. |
application | Строка | Код вида приложения.. |
app_name | Строка | Название вида приложения.. |
app_version | Строка | Версия конфигурации. |
status | Строка | Статус области (перечисление). |
url | Строка | Адрес области (с учетом витрины). |
timezone | Строка | Часовой пояс области. |
Возможные значения поля status указаны в описании метода Backup — управление архивными копиями приложений абонента#tenant/list .
backup/delete
Метод удаляет указанную архивную копию. Выполнение метода равноценно выполнению команд "Архивирование - Удалить" в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
account | Число | Код абонента. |
id | Строка | Идентификатор резервной копии. |
Ответ (1) | ||
нет параметров |
backup/file_token/download
Получить талон на скачивание файла архивной копии абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Уникальный идентификатор | Идентификатор копии | abf7c2a7-1df7-4646-9327-2866804b6ce2 |
auth | Уточнение авторизации запроса | ||
auth.type * | Строка неограниченной длины | Тип уточнения авторизации | user |
auth.account | Число (+12.0) | Код абонента | 1 010 |
Ответ | |||
direction * | Строка переменная (8) | Направление передачи данных | download |
token * | Строка переменная (64) | Талон на скачивание файла | bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb |
url * | Строка неограниченной длины | Адрес для скачивания (GET) | http://example.com/sm/hs/dt/download/bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb |
{ "id": "abf7c2a7-1df7-4646-9327-2866804b6ce2", "auth": { "account": 1010 }, "general": { "version": 9, "type": "usr", "method": "backup/file_token/download", "debug": true } }
{ "direction": "download", "token": "bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb", "url": "http://example.com/sm/hs/dt/download/bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb", "general": { "response": 10200, "error": false, "message": "", "version": 9, "sm_version": "1.0.95.3", "sm_timezone": "Europe/Moscow" } }