Методы группы files внешнего программного интерфейса менеджера сервиса предназначены для выполнения различных служебных действий с файлами.
Сводка по методам
| Метод | Назначение |
|---|---|
| files/abort_multipart | Отменить составную загрузку |
| files/complete_multipart | Завершить составную загрузку |
| files/info | Информация о файле |
| files/new_multipart | Начать составную загрузку |
| files/new_part | Сделать новую часть |
files/abort_multipart
Отменить составную загрузку
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| file_id | Строка переменная (36) | Идентификатор файла | 85bb388c-1517-11ea-6d94-0242ac130033 |
| Ответ: instance (1) | |||
| Нет параметров | |||
files/complete_multipart
Завершить составную загрузку
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| file_id | Строка переменная (36) | Идентификатор файла | 85bb388c-1517-11ea-6d94-0242ac130033 |
| parts | Массив из Строка неограниченной длины | Части | ["0c78aef83f66abc1fa1e8477f296d394"] |
| Ответ: instance (1) | |||
| Нет параметров | |||
files/info
Информация о файле
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| file_id | Строка переменная (36) | Идентификатор файла | 85bb388c-1517-11ea-6d94-0242ac130033 |
| scope * | Массив из Строка (перечисление) | Параметры получения данных:
| ["data_dump_info"] |
| Ответ: file (1) | |||
| owner | Число (7.0) | Владелец файла | 123 |
| name | Строка переменная (255) | Имя файла | data_dump.zip |
| size * | Число (+15.0) | Размер файла | 12345 |
| data_dump_info * | Информация из содержимого файла архивной копии | ||
| - conf_name * | Строка переменная (255) | Имя конфигурации, как оно задано в конфигураторе | РаботаВМоделиСервиса |
| - conf_presentation * | Строка переменная (64) | Имя конфигурации. | РаботаВМоделиСервиса |
| - apptype_presentation * | Строка переменная (150) | Наименование вида приложения | Работа в модели сервиса |
| - apptype_id * | Строка переменная (22) | Код вида приложения | mt |
| - app_version * | Строка переменная (18) | Версия конфигурации | 1.1.3.10 |
| - users | Список (0..*) | Пользователи из архивной копии | |
| - users.login | Строка переменная (50) | Логин пользователя | Abramov |
| - users.name * | Строка переменная (150) | Полное имя пользователя | Абрамов Геннадий Сергеевич |
| - users.user_id * | Уникальный идентификатор | Идентификатор пользователя из архивной копии | abf7c2a7-1df7-4646-9327-2866804b6ce2 |
| - extensions | Список (0..*) | Расширения из архивной копии | |
| - extensions.id * | Строка переменная (260) | Имя расширения | МоеРасширение |
| - extensions.description | Строка переменная (100) | Наименование расширения | Мое расширение |
| - extensions.version * | Строка переменная (18) | Версия расширения | 1.0.0.1 |
| - extensions.version_uuid | Уникальный идентификатор | Идентификатор версии расширения | abf7c2a7-1df7-4646-9327-2866804b6ce2 |
| - extensions.changes_data_structure | Булево | Расширение расширяет данные | true |
files/new_multipart
Начать составную загрузку
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| name | Строка неограниченной длины | Имя файла | data_dump.zip |
| size * | Число (+15.0) | Размер файла | 123456798 |
| type | Строка (перечисление) | Тип файла:
| tenant_backup |
| owner * | Число (7.0) | Владелец файла: для резервных копий (tenant_backup) это номер области, для выгрузок для создания приложения (new_data_dump) это код абонента | 123 |
| Ответ | |||
| file_id | Строка переменная (36) | Идентификатор файла | 85bb388c-1517-11ea-6d94-0242ac130033 |
| url | Строка неограниченной длины | Адрес | https://backups.example.ru/00/89/2b/85bb388c-1517-11ea-6d94-0242ac130033 |
| type | Строка неограниченной длины | Тип адреса - dt или s3 | s3 |
| headers | Список (0..*) | Заголовки для запроса | ["x-header-1: value1"] |
files/new_part
Сделать новую часть
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| file_id | Строка переменная (36) | Идентификатор файла | 85bb388c-1517-11ea-6d94-0242ac130033 |
| part_number | Число (3.0) | Номер части | 1 |
| Ответ | |||
| url | Строка неограниченной длины | Адрес | https://backups.example.ru/00/89/2b/85bb388c-1517-11ea-6d94-0242ac130033 |
| type | Строка неограниченной длины | Тип адреса - dt или s3 | s3 |
| headers | Список (0..*) | Заголовки для запроса | ["x-header-1: value1"] |