Backup — управление архивными копиями приложений абонента

Дата последней модификации страницы: 19.09.2024

Группа методов Backup внешнего программного интерфейса Менеджера сервиса предназначена для управления архивными копиями приложений абонента.

Для создания новых архивных копий следует использовать метод tenant/backup/create.

Сводка по методам

МетодНазначение
backup/deleteУдалить архивную копию
backup/infoИнформация об архивной копии
backup/listСписок архивных копий абонента
backup/restoreВосстановить архивную копию
backup/file_token/downloadПолучить талон на скачивание файла архивной копии абонента

backup/delete

Удалить архивную копию

ПараметрТипОписаниеПример
Запрос
idУникальный идентификаторИдентификатор копииabf7c2a7-1df7-4646-9327-2866804b6ce2
Ответ
Нет параметров
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/backup/delete
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": "abf7c2a7-1df7-4646-9327-2866804b6ce2",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

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
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/backup/info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": "abf7c2a7-1df7-4646-9327-2866804b6ce2",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "backup": {
    "tenant": 2000,
    "tenant_name": "Мое приложение",
    "id": "abf7c2a7-1df7-4646-9327-2866804b6ce2",
    "conf_name": "РаботаВМоделиСервиса",
    "app_version": "1.1.3.10",
    "app_name": "Работа в модели сервиса",
    "application": "mt",
    "utc_timestamp": "2019-03-21T00:00:00",
    "timestamp": "2019-03-21T03:00:00",
    "size": 12345,
    "is_original": false,
    "is_ondemand": true,
    "is_annual": false,
    "is_monthly": false,
    "is_daily": false,
    "for_support": false,
    "comment": "Копия перед отчетным периодом",
    "timezone": "Europe/Moscow"
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

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
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/backup/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "backup": [
    {
      "tenant": 2000,
      "tenant_name": "Мое приложение",
      "id": "abf7c2a7-1df7-4646-9327-2866804b6ce2",
      "conf_name": "РаботаВМоделиСервиса",
      "app_version": "1.1.3.10",
      "app_name": "Работа в модели сервиса",
      "application": "mt",
      "utc_timestamp": "2019-03-21T00:00:00",
      "timestamp": "2019-03-21T03:00:00",
      "size": 12345,
      "is_original": false,
      "is_ondemand": true,
      "is_annual": false,
      "is_monthly": false,
      "is_daily": false,
      "for_support": false,
      "comment": "Копия перед отчетным периодом",
      "timezone": "Europe/Moscow"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "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)Версия конфигурации1.1.3.10
app_nameСтрока переменная (64)Наименование конфигурацииРабота в модели сервиса
apptype_idСтрока переменная (22)Код вида приложенияmt
apptype_nameСтрока переменная (255)Имя вида приложенияРаботаВМоделиСервиса
apptype_presentationСтрока переменная (150)Наименование вида приложенияРабота в модели сервиса
timezone *Строка переменная (100)Часовой пояс приложенияEurope/Moscow
ownerЧисло (+12.0)Код абонента1010
statusСтрока (перечисление)Статус приложения:
  • converted (Конвертируется)
  • copied (Копируется)
  • decommissioned (К удалению)
  • error (Ошибка подготовки)
  • migration (Миграция приложения)
  • missing (Отсутствует)
  • new (Новое)
  • preparation (Готовится к использованию)
  • ready (Готово)
  • removed (Удалено)
  • used (Используется)
preparation
urlСтрока неограниченной длиныАдрес приложенияhttp://example.com/mt/2001
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/backup/restore
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": "abf7c2a7-1df7-4646-9327-2866804b6ce2",
  "name": "Приложение из архивной копии",
  "timezone": "Europe/Moscow",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "tenant": {
    "id": 2001,
    "name": "Приложение из архивной копии",
    "application": "mt",
    "app_version": "1.1.3.10",
    "app_name": "Работа в модели сервиса",
    "apptype_id": "mt",
    "apptype_name": "РаботаВМоделиСервиса",
    "apptype_presentation": "Работа в модели сервиса",
    "timezone": "Europe/Moscow",
    "owner": 1010,
    "status": "preparation",
    "url": "http://example.com/mt/2001"
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

backup/file_token/download

Получить талон на скачивание файла архивной копии абонента

ПараметрТипОписаниеПример
Запрос
idУникальный идентификаторИдентификатор копииabf7c2a7-1df7-4646-9327-2866804b6ce2
Ответ
direction *Строка (перечисление)Направление передачи данных:
  • download (Скачивание файла)
  • upload (Загрузка файла)
download
token *Строка переменная (64)Талон на скачивание файлаbacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb
url *Строка неограниченной длиныАдрес для скачивания (GET)http://example.com/sm/hs/dt/download/bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/backup/file_token/download
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": "abf7c2a7-1df7-4646-9327-2866804b6ce2",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "direction": "download",
  "token": "bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb",
  "url": "http://example.com/sm/hs/dt/download/bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх