Методы группы files внешнего программного интерфейса менеджера сервиса предназначены для выполнения различных служебных действий с файлами.
Сводка по методам
Метод | Назначение |
---|---|
files/new_multipart | Начать составную загрузку файла |
files/new_part | Сделать новую часть файла при составной загрузке |
files/complete_multipart | Завершить составную загрузку файла |
files/abort_multipart | Отменить составную загрузку файла |
files/new_multipart
Начать составную загрузку файла.
После успешного вызова метода можно загрузить первую часть файла с помощью HTTP-запроса PUT по адресу, полученному в параметре ответа url. В HTTP-запросе следует использовать HTTP-заголовки, переданные в параметре ответа headers.
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
name | Строка неограниченной длины | Имя файла | data_dump.zip |
size * | Число | Размер файла | 123 345 456 |
type | Строка неограниченной длины | Тип файла | tenant_backup |
owner * | Число | Владелец файла:
| 287 |
Ответ | |||
file_id | Строка переменная (36) | Идентификатор файла | 85bb388c-1517-11ea-6d94-0242ac130033 |
url | Строка неограниченной длины | URL для загрузки первой части файла | https://backups.example.ru/00/89/2b/85bb388c-1517-11ea-6d94-0242ac130033 |
type | Строка неограниченной длины | Тип адреса: dt или s3 | s3 |
headers * | Список (0..*) строк неограниченной длины | Заголовки для запроса при загрузке первой части файла (массив строк "заголовок: значение") | ["x-header-1: value1", "x-header-2: value2"] |
{ "name": "data_dump.zip", "size": 123456798, "type": "tenant_backup", "owner": 123, "general": { "version": 11, "type": "srv", "method": "files/new_multipart", "debug": true } }
{ "file_id": "85bb388c-1517-11ea-6d94-0242ac130033", "url": "https://backups.example.ru/00/89/2b/85bb388c-1517-11ea-6d94-0242ac130033", "type": "s3", "headers": ["x-header-1: value1"], "general": { "response": 10200, "error": false, "message": "", "version": 11, "sm_version": "1.0.97.9", "sm_timezone": "Europe/Moscow" } }
Примечания.
- Данные, хранящиеся на диске, сохраняются в специальной папке абонента: \<Том>\Subscribers\<Код абонента>\...
- Если запрос выполняется из внешнего хоста, возвращается внешний адрес для загрузки файла как для S3 так и для DT.
files/new_part
Начать загрузку следующей части файла при составной загрузке.
После успешного вызова метода можно загрузить следующую часть файла с помощью HTTP-запроса PUT по адресу, полученному в параметре ответа url. В HTTP-запросе следует использовать HTTP-заголовки, переданные в параметре ответа headers.
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
file_id | Строка переменная (36) | Идентификатор файла (полученный в параметре ответа file_id метода files/new_multipart) | 85bb388c-1517-11ea-6d94-0242ac130033 |
part_number | Число | Номер части файла, которая будет загружаться (номера частей начинаются с 1) | 3 |
Ответ | |||
url | Строка неограниченной длины | URL для загрузки следующей части файла | https://backups.example.ru/00/89/2b/85bb388c-1517-11ea-6d94-0242ac130033 |
type | Строка неограниченной длины | Тип адреса: dt или s3 | s3 |
headers * | Список (0..*) строк неограниченной длины | Заголовки для запроса при загрузке следующей части файла (массив строк "заголовок: значение") | ["x-header-1: value1", "x-header-2: value2"] |
{ "file_id": "85bb388c-1517-11ea-6d94-0242ac130033", "part_number": 1, "general": { "version": 11, "type": "srv", "method": "files/new_part", "debug": true } }
{ "url": "https://backups.example.ru/00/89/2b/85bb388c-1517-11ea-6d94-0242ac130033", "type": "s3", "headers": ["x-header-1: value1"], "general": { "response": 10200, "error": false, "message": "", "version": 11, "sm_version": "1.0.97.9", "sm_timezone": "Europe/Moscow" } }
files/complete_multipart
Завершить составную загрузку файла (метод вызывается только при загрузке файла с типом адреса s3)
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
file_id | Строка переменная (36) | Идентификатор файла (полученный в параметре ответа file_id метода files/new_multipart) | 85bb388c-1517-11ea-6d94-0242ac130033 |
parts | Список (0..*) строк неограниченной длины | Идентификаторы частей файла (они получаются из HTTP-заголовков Etag ответа при загрузке частей файла) | [ "0c78aef83f66abc1fa1e8477f296d394", "fa1e8477f296d3078aef83c1c78aef83" ] |
Ответ (1) | |||
нет параметров |
{ "file_id": "85bb388c-1517-11ea-6d94-0242ac130033", "parts": [ "0c78aef83f66abc1fa1e8477f296d394", "fa1e8477f296d3078aef83c1c78aef83" ], "general": { "version": 11, "type": "srv", "method": "files/complete_multipart", "debug": true } }
{ "general": { "response": 10200, "error": false, "message": "", "version": 11, "sm_version": "1.0.97.9", "sm_timezone": "Europe/Moscow" } }
files/abort_multipart
Отменить составную загрузку файла
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
file_id | Строка переменная (36) | Идентификатор файла (полученный в параметре ответа file_id метода files/new_multipart) | 85bb388c-1517-11ea-6d94-0242ac130033 |
Ответ (1) | |||
нет параметров |
{ "file_id": "85bb388c-1517-11ea-6d94-0242ac130033", "general": { "version": 11, "type": "srv", "method": "files/abort_multipart", "debug": true } }
{ "general": { "response": 10200, "error": false, "message": "", "version": 11, "sm_version": "1.0.97.9", "sm_timezone": "Europe/Moscow" } }