功能描述
提交一个转封装(或音视频分段)任务。
授权说明
授权策略中 action 设置为 ci:CreateMediaJobs
。查看所有 action。
服务开通
使用该功能需提前开通数据万象,并绑定存储桶。详情请参见 绑定存储桶。
使用限制
使用该接口时,请先确认相关限制条件。详情请参见 使用限制。
请求
请求示例
POST /jobs HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml
<body>
说明Authorization: Auth String(详情请参见 请求签名 文档)。通过子账号使用时,需要授予相关的权限,详情请参见 授权粒度详情 文档。
请求头
此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。
请求体
该请求操作的实现需要有如下请求体。
Segment input/demo.mp4 mp4 5 true test-key ap-chongqing test-123456789 output/out-${number} This is my data. 0 http://callback.demo.com JSON
具体的数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Request | 无 | 保存请求的容器 | Container | 是 |
Container 类型 Request 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Tag | Request | 创建任务的 Tag:Segment | String | 是 |
Input | Request | 待操作的文件信息 | Container | 是 |
Operation | Request | 操作规则 | Container | 是 |
CallBackFormat | Request | 任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式 | String | 否 |
CallBackType | Request | 任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型 | String | 否 |
CallBack | Request | 任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调 | String | 否 |
CallBackMqConfig | Request | 任务回调TDMQ配置,当 CallBackType 为 TDMQ 时必填。详情见 CallBackMqConfig | Container | 否 |
Container 类型 Input 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Object | Request.Input | 文件路径 | String | 是 |
Container 类型 Operation 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Segment | Request.Operation | 转封装参数 | Container | 是 |
Output | Request.Operation | 结果输出配置 | Container | 是 |
JobLevel | Request.Operation | 任务优先级,级别限制:0 、1 、2 。级别越大任务优先级越高,默认为0 | String | 否 |
Container 类型 Segment 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Format | Request.Operation.Segment | 封装格式,支持 aac、mp3、flac、mp4、ts、mkv、avi、hls、m3u8 | String | 是 |
Duration | Request.Operation.Segment | 转封装时长单位:秒不小于5的整数不设置 Duration 时,表示只转封装格式不分段 | String | 否 |
TranscodeIndex | Request.Operation.Segment | 处理的流编号,对应媒体信息中的 Response.MediaInfo.Stream.Video.Index 和 Response.MediaInfo.Stream.Audio.Index,详见 获取媒体信息接口 | String | 否 |
HlsEncrypt | Request.Operation.Segment | hls 加密配置,当封装格式为 hls 和 m3u8 时生效 | Container | 否 |
StartTime | Request.Operation.Segment | 开始时间取值范围: [0,视频时长],默认值为0单位为秒支持 float 格式,执行精度精确到毫秒 | String | 否 |
EndTime | Request.Operation.Segment | 结束时间取值范围:[0, 视频时长],默认值为视频结束时间单位为秒支持 float 格式,执行精度精确到毫秒 | String | 否 |
Container 类型 HlsEncrypt 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
IsHlsEncrypt | Request.Operation.Segment.HlsEncrypt | 是否开启 HLS 加密,取值 true/false,默认值 false | String | 否 |
UriKey | Request.Operation.Segment.HlsEncrypt | HLS 加密的 key,当 IsHlsEncrypt 为 true 时,该参数才有意义 | String | 否 |
Container 类型 Output 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Region | Request.Operation.Output | 存储桶的地域 | String | 是 |
Bucket | Request.Operation.Output | 存储结果的存储桶 | String | 是 |
Object | Request.Operation.Output | 输出结果的文件名,如果设置了 Duration,且 Format 不为 HLS 或 m3u8 时,文件名必须包含 ${number} 参数作为自定义转封装后每一小段音/视频流的输出序号 | String | 是 |
Request.Operation.Output.Object 支持的通配符如下:
通配符 | 含义 |
${ext} | 封装格式 |
${jobid} | 任务Id |
${number} | 产物索引,从0开始计数 |
响应
响应头
此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
Success j8d121820f5e411ec926ef19d53ba9c6f Submitted 2022-06-27T15:23:10+0800 - - p2242ab62c7c94486915508540933a2c6 Segment test-123456789 input/demo.mp4 ap-chongqing mp4 5 true test-key ap-chongqing test-123456789 output/out-${number} This is my data. 0 http://callback.demo.com JSON
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
JobsDetail | Response | 任务的详细信息 | Container 数组 |
Container 节点 JobsDetail 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Code | Response.JobsDetail | 错误码,只有 State 为 Failed 时有意义 | String |
Message | Response.JobsDetail | 错误描述,只有 State 为 Failed 时有意义 | String |
JobId | Response.JobsDetail | 新创建任务的 ID | String |
Tag | Response.JobsDetail | 新创建任务的 Tag:Segment | String |
State | Response.JobsDetail | 任务状态Submitted:已提交,待执行Running:执行中Success:执行成功Failed:执行失败Pause:任务暂停,当暂停队列时,待执行的任务会变为暂停状态Cancel:任务被取消执行 | String |
CreationTime | Response.JobsDetail | 任务的创建时间 | String |
StartTime | Response.JobsDetail | 任务的开始时间 | String |
EndTime | Response.JobsDetail | 任务的结束时间 | String |
QueueId | Response.JobsDetail | 任务所属的队列 ID | String |
Input | Response.JobsDetail | 该任务的输入资源地址 | Container |
Operation | Response.JobsDetail | 该任务的规则 | Container |
Container 节点 Input 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Region | Response.JobsDetail.Input | 存储桶的地域 | String |
Bucket | Response.JobsDetail.Input | 存储结果的存储桶 | String |
Object | Response.JobsDetail.Input | 输出结果的文件名 | String |
Container 节点 Operation 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Segment | Response.JobsDetail.Operation | 同请求中的 Request.Operation.Segment | Container |
Output | Response.JobsDetail.Operation | 同请求中的 Request.Operation.Output | Container |
MediaInfo | Response.JobsDetail.Operation | 转码输出视频的信息,任务未完成时不返回,详见 MediaInfo | Container |
MediaResult | Response.JobsDetail.Operation | 输出文件的基本信息,任务未完成时不返回,详见 MediaResult | Container |
UserData | Response.JobsDetail.Operation | 透传用户信息 | String |
JobLevel | Response.JobsDetail.Operation | 任务优先级 | String |
错误码
该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。
实际案例
请求1:mp4转封装
POST /jobs HTTP/1.1Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057Host: test-1234567890.ci.ap-chongqing.myqcloud.comContent-Length: 166Content-Type: application/xml
Segment input/demo.mkv mp4 15 ap-chongqing test-1234567890 output/out-${number} This is my data. 0 http://callback.demo.com JSON
响应1
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 230Connection: keep-aliveDate: Mon, 28 Jun 2022 15:23:12 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
Success j8d121820f5e411ec926ef19d53ba9c6f Submitted 2022-06-27T15:23:10+0800 - - p2242ab62c7c94486915508540933a2c6 Segment test-1234567890 input/demo.mkv ap-chongqing mp4 15 ap-chongqing test-123456789 output/out-${number} This is my data. 0 http://callback.demo.com JSON
请求2:hls转封装并加密
POST /jobs HTTP/1.1Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057Host: test-1234567890.ci.ap-chongqing.myqcloud.comContent-Length: 166Content-Type: application/xml
Segment input/demo.mp4 mp4 5 true test-key ap-chongqing test-1234567890 output/out-${number} This is my data. 0 http://callback.demo.com JSON
响应2
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 230Connection: keep-aliveDate: Mon, 28 Jun 2022 15:23:12 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
Success j8d121820f5e411ec926ef19d53ba9c6f Submitted 2022-06-27T15:23:10+0800 - - p2242ab62c7c94486915508540933a2c6 Segment test-1234567890 input/demo.mp4 ap-chongqing mp4 5 true test-key ap-chongqing test-123456789 output/out This is my data. 0 http://callback.demo.com JSON
对象存储官网1折活动,限时活动,即将结束,速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠
转转请注明出处:https://www.yunxiaoer.com/145148.html