文档首页/ 媒体处理 MPC/ API参考/ 独立加密接口/ 新建独立加密任务
更新时间：2024-05-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

新建独立加密任务

功能介绍

支持独立加密，包括创建、查询、删除独立加密任务。该API已废弃。

接口约束

加密的文件必须是m3u8或者mpd结尾的文件。

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/encryptions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参考获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Project_Id

否

String

使用AK/SK方式认证时必选，携带项目ID信息, 与路径参数中的项目ID相同。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。
表3 请求Body参数

参数

是否必选

参数类型

描述

input

否

ObsObjInfo object

输入存储位置

output

否

ObsObjInfo object

输出存储位置

encryption

否

Encryption object

加密信息

user_data

否

String

用户自定义数据。
表4 ObsObjInfo

参数

是否必选

参数类型

描述

bucket

是

String

OBS的bucket名称。

location

是

String

OBS桶所在的区域，且必须与使用的MPC区域保持一致。

object

是

String

OBS对象路径，遵守OSS Object定义。

  • 当用于指示input时，需要指定到具体对象。

  • 当用于指示output时，只需指定到转码结果期望存放的路径。

在字幕场景下，字幕文件名称中禁止携带特殊符号，否则会导致转码任务失败，如：[

  • 正确示例: demo.srt

  • 错误示例: [demo.srt

file_name

否

String

文件名

  • 当指定了此参数时，输出的对象名为object/file_name。

  • 当不指定此参数时，输出的对象名为object/xxx，其中xxx由MPC指定。

在作为输出文件名时：

  • 在转封装场景有效，需要指定输出文件名称

  • 在转码场景下，如果需要指定输出的文件名称，请使用output_filenames参数

  • 在解析场景有效，解析场景如果指定文件名，则将解析参数写入指定文件名，通过查询接口响应json数据获取文件元数据信息

  • 在截图场景无效

  • 在转动图场景无效

  • 输出文件为HLS格式时，文件名称不能命名为index，示例：index.m3u8，否则会导致播放失败。
表5 Encryption

参数

是否必选

参数类型

描述

hls_encrypt

否

HlsEncrypt object

视频加密控制参数。
表6 HlsEncrypt

参数

是否必选

参数类型

描述

key

是

String

使用base64编码的内容加密密钥

url

是

String

密钥获取服务的地址，用于播放hls分片时解密使用。

iv

否

String

初始向量，base64binary，随机数

algorithm

否

String

加密算法。

  • AES-128-CTR

  • AES-128-CBC

默认值：AES-128-CTR

响应参数

状态码： 202

表7 响应Body参数

参数

参数类型

描述

task_id

String

加密任务ID

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

POST https://{endpoint}/v1/{project_id}/encryptions

{
  "output" : {
    "bucket" : "example-bucket",
    "location" : "region01",
    "object" : "example-path/output"
  },
  "input" : {
    "bucket" : "example-bucket",
    "location" : "region01",
    "object" : "example-hls-path/index.m3u8"
  },
  "encryption" : {
    "hls_encrypt" : {
      "iv" : "******",
      "key" : "******",
      "url" : "http://{your-keyserver}",
      "algorithm" : "AES-128-CBC"
    }
  }
}

响应示例

状态码： 202

新建独立加密任务成功。

{
  "task_id" : 100211
}

状态码： 400

新建独立加密任务失败。

{
  "error_code" : "MPC.10202",
  "error_msg" : "Invalid request parameter"
}

状态码

状态码

描述

202

新建独立加密任务成功。

400

新建独立加密任务失败。

错误码

请参见错误码。

父主题： 独立加密接口

相关文档