接口功能介绍
用户可在点播模式下通过本接口向云点播提交一个转码任务。
接口约束
本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。
URI
POST /task/submit
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| videoId | 是 | String | 视频id | 34c71dba-f280-4f5e-a05f-f4daed837fef | |
| useDefaultTranscodeTemplate | 否 | Boolean | 可选参数，是否使用默认的转码模板。如果不传入默认为 false。 | true | |
| transcodeTemplates | 否 | Array of Longs | 当 useDefaultTranscodeTemplate为 true 时，该字段无效。当 useDefaultTranscodeTemplate 为 fasle 或者不传入时，该字段必填。 |
[100000000003,100000000004] | |
| watermarkTemplate | 否 | Long | 可选参数，水印模板id：若传入表示加水印；不传入则不加水印。 | 100000000003 | |
| callback | 否 | String | 可选参数，任务结束之后将回调到该地址告知任务状态。 | http://callback.ctyun.cn/callback |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | Integer | 本次请求的结果码。 | 0 | |
| message | 是 | String | 错误文本信息，执行成功时，为空字符串。 | "" | |
| data | 是 | Object | 返回数据。 | data |
表 data
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| transcodeTaskIds | 是 | Array of Strings | 转码任务的 id，可以通过这些转码任务 id 查询相关的任务。 | ["0001#1a619cdd3f19406794f9663ee246cb7e", "0001#1a619cdd3f19406794f9663ee246cbr8"] |
请求示例
请求体body
{
"videoId": "34c71dba-f280-4f5e-a05f-f4daed837fef",
"useDefaultTranscodeTemplate": true,
"transcodeTemplates": [100000000003, 100000000004],
"watermarkTemplate": 100000000003,
"callback": "http://callback.ctyun.cn/callback"
}
响应示例
{
"code": 0,
"message": "",
"data": {
"transcodeTaskIds": ["0001#1a619cdd3f19406794f9663ee246cb7e", "0001#1a619cdd3f19406794f9663ee246cbr8"]
}
}
状态码
| Http 状态码 | 状态码信息 | 状态码描述 |
|---|---|---|
| 0 | 表示业务成功 | 表示业务成功 |
| 400 | 请求参数有误 | 请求参数有误 |
| 403 | 用户鉴权失败，用户无操作权限 | 用户鉴权失败，用户无操作权限 |
| 404 | 请求的资源不存在，输入错误的URL | 请求的资源不存在，输入错误的URL |
| 500 | 业务执行异常 | 业务执行异常 |
错误码
OpenAPI错误码请参考 错误码说明。
