Группа методов Backup внешнего программного интерфейса Менеджера сервиса предназначена для управления архивными копиями приложений абонента.
Для создания новых архивных копий следует использовать метод tenant/backup/create.
Сводка по методам
| Метод | Назначение |
|---|---|
| backup/delete | Удалить архивную копию |
| backup/info | Информация об архивной копии |
| backup/list | Список архивных копий абонента |
| backup/restore | Восстановить архивную копию |
| backup/file_token/download | Получить талон на скачивание файла резервной копии абонента или идентификатор задания объединения файла резервной копии |
backup/delete
Удалить архивную копию
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| id | Уникальный идентификатор | Идентификатор копии | abf7c2a7-1df7-4646-9327-2866804b6ce2 |
| Ответ: application (1..*) | |||
| Нет параметров | |||
backup/info
Информация об архивной копии
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| id | Уникальный идентификатор | Идентификатор копии | abf7c2a7-1df7-4646-9327-2866804b6ce2 |
| Ответ: backup (1) | |||
| tenant | Число (+7.0) | Номер приложения | 2000 |
| tenant_name | Строка переменная (100) | Название приложения | Мое приложение |
| id | Уникальный идентификатор | Идентификатор копии | abf7c2a7-1df7-4646-9327-2866804b6ce2 |
| conf_name | Строка переменная (255) | Имя конфигурации, как оно задано в конфигураторе | РаботаВМоделиСервиса |
| app_version | Строка переменная (18) | Версия конфигурации | 1.1.3.10 |
| app_name | Строка переменная (150) | Наименование вида приложения | Работа в модели сервиса |
| application | Строка переменная (22) | Код вида приложения | mt |
| utc_timestamp | Дата и время в строке формата ISO | Момент создания (универсальное время) | 21.03.2019 0:00:00 |
| timestamp | Дата и время в строке формата ISO | Момент создания (местное время) | 21.03.2019 3:00:00 |
| size | Число (+15.0) | Размер файла | 12345 |
| is_original | Булево | Это исходный образ приложения | false |
| is_ondemand | Булево | Это копия по требованию | true |
| is_annual | Булево | Это ежегодная копия | false |
| is_monthly | Булево | Это ежемесячная копия | false |
| is_daily | Булево | Это ежедневная копия | false |
| for_support | Булево | Это копия для тех. поддержки | false |
| comment * | Строка неограниченной длины | Комментарий к архивной копии | Копия перед отчетным периодом |
| timezone * | Строка переменная (100) | Часовой пояс приложения | Europe/Moscow |
| file_name * | Строка неограниченной длины | Рекомендуемое имя файла для сохранения. | data_dump.zip |
backup/list
Список архивных копий абонента
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| start_date * | Дата и время в строке формата ISO | Дата создания РК. Начальная, для отбора по периоду | 28.02.2019 0:00:00 |
| end_date * | Дата и время в строке формата ISO | Дата создания РК. Конечная, для отбора по периоду | 26.03.2020 0:00:00 |
| Ответ: backup (0..*) | |||
| tenant | Число (+7.0) | Номер приложения | 2000 |
| tenant_name | Строка переменная (100) | Название приложения | Мое приложение |
| id | Уникальный идентификатор | Идентификатор копии | abf7c2a7-1df7-4646-9327-2866804b6ce2 |
| conf_name | Строка переменная (255) | Имя конфигурации, как оно задано в конфигураторе | РаботаВМоделиСервиса |
| app_version | Строка переменная (18) | Версия конфигурации | 1.1.3.10 |
| app_name | Строка переменная (150) | Наименование вида приложения | Работа в модели сервиса |
| application | Строка переменная (22) | Код вида приложения | mt |
| utc_timestamp | Дата и время в строке формата ISO | Момент создания (универсальное время) | 21.03.2019 0:00:00 |
| timestamp | Дата и время в строке формата ISO | Момент создания (местное время) | 21.03.2019 3:00:00 |
| size | Число (+15.0) | Размер файла | 12345 |
| is_original | Булево | Это исходный образ приложения | false |
| is_ondemand | Булево | Это копия по требованию | true |
| is_annual | Булево | Это ежегодная копия | false |
| is_monthly | Булево | Это ежемесячная копия | false |
| is_daily | Булево | Это ежедневная копия | false |
| for_support | Булево | Это копия для тех. поддержки | false |
| comment * | Строка неограниченной длины | Комментарий к архивной копии | Копия перед отчетным периодом |
| timezone * | Строка переменная (100) | Часовой пояс приложения | Europe/Moscow |
backup/restore
Восстановить архивную копию
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| id | Уникальный идентификатор | Идентификатор копии | abf7c2a7-1df7-4646-9327-2866804b6ce2 |
| name * | Строка переменная (100) | Название нового приложения | Приложение из архивной копии |
| timezone * | Строка переменная (100) | Часовой пояс нового приложения | Europe/Moscow |
| Ответ: tenant (1) | |||
| id | Число (+7.0) | Номер приложения | 2001 |
| name | Строка переменная (100) | Название приложения | Приложение из архивной копии |
| application | Строка переменная (22) | Код вида приложения (устарело) | mt |
| app_version | Строка переменная (18) | Версия конфигурации | 2.0.14.10 |
| app_name | Строка переменная (64) | Наименование конфигурации | Работа в модели сервиса |
| apptype_id | Строка переменная (22) | Код вида приложения | mt |
| apptype_name | Строка переменная (255) | Имя вида приложения | РаботаВМоделиСервиса |
| apptype_presentation | Строка переменная (150) | Наименование вида приложения | Работа в модели сервиса |
| timezone * | Строка переменная (100) | Часовой пояс приложения | Europe/Moscow |
| owner | Число (+12.0) | Код абонента | 1010 |
| status | Строка (перечисление) | Статус приложения:
| preparation |
| url | Строка неограниченной длины | Адрес приложения | http://example.com/mt/2001 |
| user_language * | Строка переменная (3) | Код языка текущего пользователя в приложении. | ru |
backup/file_token/download
Получить талон на скачивание файла резервной копии абонента или идентификатор задания объединения файла резервной копии
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| id | Уникальный идентификатор | Идентификатор копии | abf7c2a7-1df7-4646-9327-2866804b6ce2 |
| task_id * | Уникальный идентификатор | Идентификатор задания объединения РК. Для получения ссылки на скачивание РК нужно не ранее, чем через минуту, повторно запросить РК, указав в запросе параметр "task_id" с тем же значением | a5fbf974-9073-11ef-8b0a-0242ac120007 |
| Ответ | |||
| direction * | Строка (перечисление) | Направление передачи данных:
| download |
| token * | Строка переменная (64) | Талон на скачивание файла | bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb |
| url * | Строка неограниченной длины | Адрес для скачивания (GET) | http://example.com/sm/hs/dt/download/bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb |
| task_id * | Уникальный идентификатор | Идентификатор задания объединения РК. Указывается при повторном запросе РК, значение параметра ответа "task_id" первоначального запроса РК | a5fbf974-9073-11ef-8b0a-0242ac120007 |
| file_name * | Строка неограниченной длины | Рекомендуемое имя файла для сохранения. | data_dump.zip |
| expires_at * | Дата и время в строке формата ISO | Срок действия талона | 05.06.2025 1:02:03 |