Работа с файлами и папками

Получить файл/папку

URL: https://apicdn.rcloud.ru/app/storage/v1/<your_account_name>/files<path>

• Тип запроса: GET

• Доступные querystring-параметры (актуальны только при запросе папки):

  Название	Допустимые значения	Описание
  dirs_only	пустое значение/1/true/0/false	Вернуть только дочерние папки
  files_only	пустое значение/1/true/0/false	Вернуть только дочерние файлы

• Возможные коды ответа:

  Код ответа	Данные ответа	Описание
  200	Данные о сущности	-
  404	status: "Not Found"	Сущность по указанному пути не найдена
  422	status: "Unprocessable Entity"	Ошибка в значениях параметров (см. description)

• Формат данных о сущности (файле или папке):

  Ключ	Описание
  id	Идентификатор
  name	Название
  path	Полный путь
  is_dir	Является ли сущность папкой
  size	Размер в байтах
  content_type	Content-Type файла
  create_time	timestamp создания
  change_time	timestamp последнего изменения
  expiration_time	timestamp будущего удаления файла
  download_url	Ссылка для загрузки файла
  hls_url	Ссылка для просмотра файла в HLS (только для MP4-файлов)
  mpeg_dash_url	Ссылка для просмотра файла в MPEG-DASH (только для MP4-файлов)
  contents	Дочерние элементы папки

curl 'https://apicdn.rcloud.ru/app/storage/v1/testaccount/files' -H "CDN-AUTH-TOKEN: $TOKEN"

{
  "status": "Completed",
  "dirs_only": false,
  "files_only": false,
  "data": {
    "id": "606ef5635edc39a2f2832b7d",
    "name": "testaccount",
    "path": "/",
    "is_dir": true,
    "status": "",
    "size": 0,
    "content_type": "",
    "description": "12884901888",
    "create_time": 0,
    "change_time": 1641804692,
    "download_url": "",
    "contents": [
      {
        "id": "619e2531bc9fae0001083968",
        "name": "ansi_scte-35-2019a-1582645390859.pdf",
        "path": "/ansi_scte-35-2019a-1582645390859.pdf",
        "is_dir": false,
        "status": "ok",
        "size": 1633004,
        "content_type": "application/pdf",
        "description": "",
        "create_time": 1637754161,
        "change_time": 1637754161,
        "download_url": "https://prefix.a.trbcdn.net/cdn/testaccount/ansi_scte-35-2019a-1582645390859.pdf"
      },
      {
        "id": "617802e6cd0b6b1be6948e2b",
        "name": "road - 11018.mp4",
        "path": "/road - 11018.mp4",
        "is_dir": false,
        "status": "ok",
        "size": 54419074,
        "content_type": "video/mp4",
        "description": "",
        "create_time": 1635255020,
        "change_time": 1635255024,
        "download_url": "https://prefix.a.trbcdn.net/cdn/testaccount/road%20-%2011018.mp4",
        "hls_url": "https://prefix.a.trbcdn.net/cdn/testaccount/road%20-%2011018.mp4/playlist.m3u8",
        "mpeg_dash_url": "https://prefix.a.trbcdn.net/cdn/testaccount/road%20-%2011018.mp4/manifest.mpd"
      }
    ],
    "paging": {
      "count": 2,
      "count_on_page": 2
    }
  }
}

{
  "status": "Unprocessable Entity",
  "description": {
    "files_only": [
      "Not a valid boolean."
    ]
  }
}

Создать файл/папку

URL: https://apicdn.rcloud.ru/app/storage/v1/<your_account_name>/files<path>

• Тип запроса: POST
• Content-Type тела запроса: multipart/form-data (в случае создания папки допустим application/x-www-form-urlencoded)

• Доступные параметры (взаимоисключающие):

  Название	Допустимые значения	Описание
  file	бинарное содержимое файла	Содержимое создаваемого файла
  dir	пустое значение/1/true/0/false	Указание создать директорию

• Возможные коды ответа:

  Код ответа	Данные ответа	Описание
  200	status: "Completed"	Папка уже существует*
  201	status: "Completed"	Сущность успешно создана
  422	status: "Unprocessable Entity"	Ошибка в значениях параметров (см. description)

  
  

  Обратите внимание

  * - в случае повторного запроса на создание файла к его названию добавится числовой суффикс

curl 'https://apicdn.rcloud.ru/app/storage/v1/testaccount/files/data.csv' -F "file=@data.csv" -H "CDN-AUTH-TOKEN: $TOKEN" 

{
  "status": "Completed"
}

{
  "status": "Unauthorized",
  "description": "Invalid token"
}

Изменить файл/папку

URL: https://apicdn.rcloud.ru/app/storage/v1/<your_account_name>/files<path>

• Тип запроса: PATCH
• Content-Type тела запроса: application/json

• Доступные параметры:

  Название	Допустимые значения	Описание
  name	Валидная строка	Новое название сущности
  dir	Валидная строка	Путь новой родительской директории

  
  

  Валидная строка

  Значение name может содержать любые символы, за исключением :, ?, *, \, /, " и |.
  Пример: новый файл (1).mp4.
  Значение dir может содержать любые символы, за исключением :, ?, *, \, " и |.
  Пример: /new parent folder (1).

• Возможные коды ответа:

  Код ответа	Данные ответа	Описание
  200	status: "Completed"	Сущность успешно изменена
  404	status: "Not Found"	Сущность по указанному пути не найдена
  422	status: "Unprocessable Entity"	Ошибка в значениях параметров (см. description)

curl 'https://apicdn.rcloud.ru/app/storage/v1/testaccount/files/test_folder' -X PATCH --data '{"name": "test_folder2", "dir": "/new_parent_folder"}' -H "Content-Type: application/json" -H "CDN-AUTH-TOKEN: $TOKEN" 

{
  "status": "Completed"
}

{
  "status": "Unprocessable Entity",
  "description": [
    "No data provided"
  ]
}

Удалить файл/папку

URL: https://apicdn.rcloud.ru/app/storage/v1/<your_account_name>/files<path>

• Тип запроса: DELETE

• Возможные коды ответа:

  Код ответа	Данные ответа	Описание
  204	Пустой ответ	Сущность успешно удалена
  404	status: "Not Found"	Сущность по указанному пути не найдена
  423	status: "Locked"	Сущность заблокирована*

  
  

  Обратите внимание

  * - либо сущность является файлом, в который всё ещё ведётся запись, либо папкой, содержащей подобный файл (см. "DVR и запись потока")

curl 'https://apicdn.rcloud.ru/app/storage/v1/testaccount/files/test_folder' -X DELETE -H "CDN-AUTH-TOKEN: $TOKEN" 

{
  "status": "Locked",
  "description": "Entity is locked"
}