Методы группы 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 *Число

Владелец файла:

  • для резервных копий (tenant_backup) это номер области
  • для выгрузок для создания приложения (new_data_dump) это код абонента
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"
}
}

Примечания.

  1. Данные, хранящиеся на диске, сохраняются в специальной папке абонента: \<Том>\Subscribers\<Код абонента>\...
  2. Если запрос выполняется из внешнего хоста, возвращается внешний адрес для загрузки файла как для 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"
}
}

 Вверх