Работа с задачами на транскодирование

Получить все задачи на транскодирование

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

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

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

  Название	Допустимые значения	Описание
  start	Валидные дата и время	Начало интервала фильтра задач*
  end	Валидные дата и время	Конец интервала фильтра задач*

  
  

  Валидные дата и время

  Значение даты и времени (start, end) передается в формате YYYY-MM-DDThh:mm:ssZ в UTC.
  Пример: 2021-12-30T12:30:05Z

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

  * - задачи фильтруются по моменту их создания

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

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

• Формат данных о задачах:

  Ключ	Описание
  id	Идентификатор
  status	Статус выполнения
  description	Описание статуса

{
  "status": "Completed",
  "end": "2022-10-10T00:01:02Z",
  "start": "2021-10-10T00:00:00Z",
  "data": [
    {
      "id": "934136bf48c2412f9f1bb853f92a4c8a",
      "status": "Completed",
      "description": "Encoding video success."
    },
    {
      "id": "ba27bc62e9da46e48a406adabc50aec8",
      "status": "Completed",
      "description": "Encoding video success."
    }
  ]
}

Получить конкретную задачу на транскодирование

URL: https://apicdn.rcloud.ru/app/storage/v1/<your_account_name>/transcode/<task_id>

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

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

  Код ответа	Данные ответа	Описание
  200	Данные о задаче	-
  404	status: "Task not found"	Задача с указанным ID не найдена
  422	status: "Unprocessable Entity"	Ошибка в значении task_id (см. description)

• Формат данных о задачах:

  Ключ	Описание
  id	Идентификатор
  status	Статус выполнения
  description	Описание статуса

{
  "status": "Completed",
  "data": {
    "id": "ba27bc62e9da46e48a406adabc50aec8",
    "status": "Completed",
    "description": "Encoding video success."
  }
}

Получить пресеты транскодирования

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

URL: https://apicdn.rcloud.ru/app/storage/v1/<your_account_name>/transcode/presets

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

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

  Код ответа	Данные ответа	Описание
  200	Данные о пресетах	-

{
  "status": "Completed",
  "data": {
    "presets": [
      {
        "id": "5676a27cf9cb101634000002",
        "name": "Fixed iframes: 1080p - watermark",
        "container": "mp4",
        "video": {
          "codec": "H.264",
          "bit_rate": "5400",
          "fps": "30",
          "keyframes_max_dist": "150",
          "max_width": "1920",
          "max_height": "1080",
          "profile": "baseline",
          "level": "4",
          "sizing_policy": "ShrinkToFit",
          "padding_policy": "NoPad",
          "aspect_ratio": "auto"
        },
        "audio": {
          "codec": "AAC",
          "bit_rate": "160",
          "sample_rate": "44100",
          "channels": "2"
        },
        "watermarks": {
          "BottomLeft": {
            "horizontal_align": "Left",
            "horizontal_offset": "10%",
            "vertical_align": "Bottom",
            "vertical_offset": "10%",
            "height": "",
            "width": "",
            "max_height": "10%",
            "max_width": "10%",
            "opacity": "100",
            "sizing_policy": "ShrinkToFit"
          },
          "BottomRight": {
            "horizontal_align": "Right",
            "horizontal_offset": "10%",
            "vertical_align": "Bottom",
            "vertical_offset": "10%",
            "height": "",
            "width": "",
            "max_height": "10%",
            "max_width": "10%",
            "opacity": "100",
            "sizing_policy": "ShrinkToFit"
          },
          "Full": {
            "horizontal_align": "Left",
            "horizontal_offset": "0%",
            "vertical_align": "Top",
            "vertical_offset": "0%",
            "height": "",
            "width": "",
            "max_height": "100%",
            "max_width": "100%",
            "opacity": "100",
            "sizing_policy": "Fit"
          },
          "TopRight": {
            "horizontal_align": "Right",
            "horizontal_offset": "10%",
            "vertical_align": "Top",
            "vertical_offset": "10%",
            "height": "",
            "width": "",
            "max_height": "10%",
            "max_width": "10%",
            "opacity": "100",
            "sizing_policy": "ShrinkToFit"
          }
        },
        "standard": true,
        "tags": [
          "Popular 16:9"
        ]
      },
      ...
    ]
  }
}

Получить статистику по задачам на транскодирование

URL: https://apicdn.rcloud.ru/app/storage/v1/<your_account_name>/transcode/stats

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

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

  Название	Допустимые значения	Описание
  start	Валидные дата и время	Начало интервала фильтра задач*
  end	Валидные дата и время	Конец интервала фильтра задач*

  
  

  Валидные дата и время

  Значение даты и времени (start, end) передается в формате YYYY-MM-DDThh:mm:ssZ в UTC.
  Пример: 2021-12-30T12:30:05Z

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

  * - задачи фильтруются по моменту их создания

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

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

• Формат статистики по задачам:

  Ключ	Описание
  transcode_operations	Количество выполненных задач транскодирования
  transcode_minutes	Длина транскодированных (выходных) файлов в минутах в разбивке по качествам (SD, HD)

{
  "status": "Completed",
  "end": "2022-10-10T00:01:02Z",
  "start": "2021-10-10T00:00:00Z",
  "data": {
    "transcode_operations": 12,
    "transcode_minutes": {
      "SD": 14,
      "HD": 5
    }
  }
}

Создать задачу на транскодирование $

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

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

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

  Название	Обязательный	Значение по умолчанию	Допустимые значения	Описание
  object_id	Да	-	ID файла	Идентификатор файла, который нужно транскодировать
  presets	Да/Нет	Пустой список	Список ID пресетов	Пресеты, в которые нужно транскодировать исходный файл
  path	Нет	Папка исходного файла	Валидная строка	Путь, в который нужно поместить выходные файлы
  delete_original	Нет	false	Boolean	Удалить ли исходный файл после завершения задачи
  start	Да/Нет	0	Целое число (секунда)	Начало интервала исходного файла, который нужно транскодировать
  duration	Да/Нет	0	Целое число (секунды)	Длительность интервала исходного файла, который нужно транскодировать
  send_email	Нет	false	Boolean	Отправлять ли уведомление на почту о завершении задачи

  
  

  presets, start и duration

  presets становятся обязательными, если не указываются ни ненулевой start, ни ненулевой duration.
  start становится обязательным, если не указываются ни presets, ни ненулевой duration.
  duration становится обязательным, если не указываются ни presets, ни ненулевой start

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

  Валидность значения path определяется так же, как и значения dir в Изменить файл/папку

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

  Код ответа	Данные ответа	Описание
  201	task_id	Задача успешно создана
  400	description: "Bad parameters"	Не удалось создать задачу с переданными параметрами
  404	description: "Object with object_id not found"	Не удалось найти исходный файл по переданному идентификатору
  422	status: "Unprocessable Entity"	Ошибка в значениях параметров (см. description)

{
  "status": "Completed",
  "data": {
    "task_id": "78e18299a591419fba61d7cab3ccf8b3"
  }
}