Произвольные непубличные статические файлы домена (files)

Обзор

Предоставляет доступ к файлам в общем каталоге непубличных файлов домена.

Содержащиеся в каталоге файлы загружаются администратором домена, и могут быть назначены для использования некоторыми сущностями домена. Например, при настройке сертификатов в domain.settings.sber_salute в качестве сертификата к эндпойнту указывается путь к сертификату. Так, URL `/rest/v1/fs/targets/files/certificates/x.local.pem` соответствует макро пути ':SYNC_DOMAIN/data/files/certificates/x.local.pem`.

Поддерживается работа с вложенной структурой произвольной глубины. При размещении файла путь автоматически создается, при удалении файла пустые каталоги автоматически удаляются.

Каталог располагается в категории автоматически синхронизирующихся каталогов :SYNC.

Запросы

HTTP verb Endpoint Описание

POST

/rest/v1/fs/targets/files

Заливка группы файлов

GET

/rest/v1/fs/targets/files

Получение списка файлов

GET

/rest/v1/fs/targets/files/<filename>

Скачивание файла

PUT

/rest/v1/fs/targets/files/<filename>

Перезаливка существующего файла

DELETE

/rest/v1/fs/targets/files/<filename>

Удаление файла

HEAD

/rest/v1/fs/targets/files/<filename>

Получение мета-информации о файле

Заливка группы файлов

Загрузка в коллекцию производится с помощью Content-Type: multipart/formdata.

В запросе может быть один или несколько файлов. Файлы размещаются под именами, указанными в заголовках Content-Disposition каждой части.

Если файл с указанным именем уже существует, то он не сохраняется и возвращает ошибку. В зависимости от Content-Type и наличия успешно размещенных файлов в запросе может быть возвращен неудачный HTTP-ответ, либо информация о неудаче в теле HTTP-ответа 200 OK.

Запрос

Пример запроса
POST /rest/v1/fs/targets/files HTTP/1.1
Content-Type: multipart/form-data; boundary=-----------boundary_69df8120352a996e

-----------boundary_69df8120352a996e
Content-Type: application/octet-stream
Content-Disposition: form-data; name="filename"; filename="test.local.pem"
Content-Transfer-Encoding: binary

BINARY BODY OF 'test.local.pem'
-----------boundary_69df8120352a996e--

Ответ

Пример ответа
[
  {
    "name": "test.local.pem",
    "size": 19542,
    "status": "ok"
  }
]

Получение списка файлов

Запрос

Table 1. Параметры запроса
Имя Тип Описание

filter

object

Фильтр по значениям полей.

mask

str

Список полей для вывода. Доступные поля для выдачи: name, size, last_modified.

offset

int

Смещение в списке файлов, подлежащих выдаче.

limit

int

Максимальное количество файлов в списке.

order

array<object|str>

Порядок сортировки файлов в списке.

Подробно про формат параметров GET-запроса

Пример запроса
GET /rest/v1/fs/targets/files HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "last_modified": "2023-07-30 20:03:59",
    "name": "certificates",
    "type": "directory"
  },
  {
    "last_modified": "2023-07-31 13:12:32",
    "name": "test.local.pem",
    "size": 19542
  }
]

Скачивание файла

Запрос

Table 2. Параметры запроса
Имя Тип Описание

attachment

bool

Тип выдачи. По умолчанию false.

true – выдаётся с заголовком Content-Disposition: attachment; filename=filename.ext либо Content-Disposition: attachment; filename*=UTF-8''%d1%84%d0%b0%d0%b9%d0%bb.ext, где файл.ext – имя файла в кодировке UTF-8 и URLencoded.

false – выдается без заголовка Content-Disposition.
Пример запроса
GET /rest/v1/fs/targets/files/test.local.pem?attachment=true HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/octet-stream; charset=utf-8
Content-Disposition: attachment; filename*=UTF-8''doc%20123.html

BINARY BODY OF 'doc 123.html'

Перезаливка существующего файла

Производит замену файла.

Загрузка одного файла производится либо с помощью Content-Type: multipart/formdata, либо с произвольным Content-Type не являющимся мультипартом.

Если загрузка происходит с Content-Type: multipart/formdata, то будет сохранён только первый файл (первая часть имеющая поле filename в заголовке Content-Disposition), а само название файла будет проигнорировано.

Запрос

Пример запроса (octet-stream)
PUT /rest/v1/fs/targets/files/test.local.pem HTTP/1.1
Content-Type: application/octet-stream

BINARY BODY OF 'test.local.pem'
Пример запроса (multipart)
PUT /rest/v1/fs/targets/files/test.local.pem HTTP/1.1
Content-Type: multipart/form-data; boundary=-----------boundary_69df8120352a996e

-----------boundary_69df8120352a996e
Content-Type: application/octet-stream
Content-Disposition: form-data; name="test.local.pem"; filename="test.local.pem"
Content-Transfer-Encoding: binary

BINARY BODY OF 'test.local.pem'
-----------boundary_69df8120352a996e--

Ответ

Пример ответа
HTTP/1.1 204 No Content

Удаление файла

Запрос

Пример запроса
DELETE /rest/v1/fs/targets/files/test.local.pem HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 204 No Content

Получение мета-информации о файле

Возвращает мета-информацию о файле, содержащую в том числе размер в заголовке Content-Length.

Особенности

  • HTTP-ответ не содержит тела, несмотря на наличие заголовка Content-Length.

Запрос

Table 3. Параметры запроса
Имя Тип Описание

attachment

bool

Тип выдачи. По умолчанию false.

true – выдаётся с заголовком Content-Disposition: attachment; filename=filename.ext либо Content-Disposition: attachment; filename*=UTF-8''%d1%84%d0%b0%d0%b9%d0%bb.ext, где файл.ext – имя файла в кодировке UTF-8 и URLencoded.

false – выдается без заголовка Content-Disposition.
Пример запроса
HEAD /rest/v1/fs/targets/files/test.local.pem?attachment=true HTTP/1.1

Ответ

Пример успешного ответа
HTTP/1.1 200 OK
content-length: 19542
content-type: application/octet-streaqm
date: Fri, 14 Jan 2022 06:29:04 GMT
server: Cowboy
Пример неуспешного ответа
HTTP/1.1 404 Not Found
  • Персонализация
  • Увеличить шрифт
  • Уменьшить шрифт