功能描述
CreateMediaJobs 用于提交一个任务。
请求
请求示例
POST /jobs HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml<body>
说明
请求头
请求体
该请求操作的实现需要有如下请求体。
<Request><Tag>Transcode</Tag><Input><Object></Object></Input><Operation><TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId><Output><Region></Region><Bucket></Bucket><Object></Object></Output></Operation><QueueId></QueueId><CallBack></CallBack></Request>
具体的数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Request | 无 | 保存请求的容器 | Container | 是 |
Container 类型 Request 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Tag | Request | 创建任务的 Tag:Transcode | String | 是 |
Input | Request | 待操作的媒体信息 | Container | 是 |
Operation | Request | 操作规则,支持对单个文件执行多个不同任务,最多可填写6个 | Container | 是 |
QueueId | Request | 任务所在的队列 ID | String | 是 |
CallBack | Request | 回调地址 | String | 否 |
Container 类型 Input 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Object | Request.Input | 媒体文件名 | String | 是 |
Container 类型 Operation 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Transcode | Request.Operation | 指定转码模板参数 | Container | 否 |
Watermark | Request.Operation | 指定水印模板参数,同创建水印模板 CreateMediaTemplate 接口的 Request.Watermark | Container | 否 |
RemoveWatermark | Request.Operation | 指定去除水印参数 | Container | 否 |
TemplateId | Request.Operation | 指定的模板 ID | String | 否 |
WatermarkTemplateId | Request.Operation | 指定的水印模板 ID,可以传多个水印模板 ID | String | 否 |
Output | Request.Operation | 结果输出地址 | Container | 是 |
注意
优先使用 TemplateId,无 TemplateId 时使用对应任务类型的参数。
Container 类型 Transcode 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Container | Request.Operation.Transcode | 同创建转码模板 CreateMediaTemplate 接口中的 Request.Container | Container | 否 |
Video | Request.Operation.Transcode | 同创建转码模板 CreateMediaTemplate 接口中的 Request.Video | Container | 否 |
TimeInterval | Request.Operation.Transcode | 同创建转码模板 CreateMediaTemplate 接口中的 Request.TimeInterval | Container | 否 |
Audio | Request.Operation.Transcode | 同创建转码模板 CreateMediaTemplate 接口中的 Request.Audio | Container | 否 |
TransConfig | Request.Operation.Transcode | 同创建转码模板 CreateMediaTemplate接口中的 Request.TransConfig | Container | 否 |
Container 类型 RemoveWatermark 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 必选 |
Dx | Request.Operation.RemoveWatermark | 距离左上角原点 x 偏移,范围为[1, 4096] | string | 是 |
Dy | Request.Operation.RemoveWatermark | 距离左上角原点 y 偏移,范围为[1, 4096] | string | 是 |
Width | Request.Operation.RemoveWatermark | 宽,范围为[1, 4096] | string | 是 |
Height | Request.Operation.RemoveWatermark | 高,范围为[1, 4096] | string | 是 |
Container 类型 Output 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Region | Request.Operation.Output | 存储桶的地域 | String | 是 |
Bucket | Request.Operation.Output | 存储结果的存储桶 | String | 是 |
Object | Request.Operation.Output | 输出结果的文件名 | String | 是 |
响应
响应头
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response><JobsDetail><Code></Code><Message></Message><JobId></JobId><State></State><CreationTime></CreationTime><EndTime></EndTime><QueueId></QueueId><Tag>Transcode</Tag><Input><Object></Object></Input><Operation><TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId><Output><Region></Region><Bucket></Bucket><Object></Object></Output><MediaInfo></MeidaInfo></Operation></JobsDetail></Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
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:Transcode | 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 | 该任务的规则,支持对单个文件执行多个不同任务,最多可填写6个 | Container |
Container 节点 Input 的内容:
同请求中的 Request.Input 节点。
Container 节点 Operation 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
TemplateId | Response.JobsDetail.Operation | 任务的模板 ID | String |
Output | Response.JobsDetail.Operation | 文件的输出地址 | Container |
MediaInfo | Response.JobsDetail.Operation | 转码输出视频的信息,没有时不返回 | Container |
Container 节点 Output 的内容:
同请求中的 Request.Operation.Output 节点。
错误码
实际案例
请求1:使用转码模板 ID
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: examplebucket-1250000000.ci.ap-beijing.myqcloud.comContent-Length: 166Content-Type: application/xml<Request><Tag>Transcode</Tag><Input><Object>test.mp4</Object></Input><Operation><TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId><Output><Region>ap-beijing</Region><Bucket>examplebucket-1250000000</Bucket><Object>test-trans.mkv</Object></Output><RemoveWatermark><Dx>128</Dx><Dy>128</Dy><Width>256</Width><Height>256</Height></RemoveWatermark></Operation><QueueId>p893bcda225bf4945a378da6662e81a89</QueueId><CallBack>https://www.callback.com</CallBack></Request>
响应1
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 230Connection: keep-aliveDate: Thu, 15 Jun 2017 12:37:29 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response><JobsDetail><Code>Success</Code><Message>Success</Message><JobId>je8f65004eb8511eaaed4f377124a303c</JobId><State>Submitted</State><CreationTime>2019-07-07T12:12:12+0800</CreationTime><EndTime></EndTime><QueueId>p893bcda225bf4945a378da6662e81a89</QueueId><Tag>Transcode</Tag><Input><Object>test.mp4</Object></Input><Operation><TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId><Output><Region>ap-beijing</Region><Bucket>examplebucket-1250000000</Bucket><Object>test-trans.mkv</Object></Output><RemoveWatermark><Dx>128</Dx><Dy>128</Dy><Width>256</Width><Height>256</Height></RemoveWatermark></Operation></JobsDetail></Response>
请求2:使用转码处理参数
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: examplebucket-1250000000.ci.ap-beijing.myqcloud.comContent-Length: 166Content-Type: application/xml<Request><Tag>Transcode</Tag><Input><Object>test.mp4</Object></Input><Operation><Transcode><Container><Format>mp4</Format></Container><Video><Codec>H.264</Codec><Profile>high</Profile><Bitrate>1000</Bitrate><Crf></Crf><Width>1280</Width><Height></Height><Fps>30</Fps><Gop></Gop><Preset>medium</Preset><ScanMode></ScanMode><Bufsize>0</Bufsize><Maxrate>0</Maxrate></Video><Audio><Codec>aac</Codec><Samplerate>44100</Samplerate><Bitrate>128</Bitrate><Channels>4</Channels></Audio><TransConfig><AdjDarMethod>rescale</AdjDarMethod><IsCheckReso>false</IsCheckReso><ResoAdjMethod>1</ResoAdjMethod></TransConfig><TimeInterval><Start>0</Start><Duration>60</Duration></TimeInterval></Transcode><Watermark><Type>Text</Type><LocMode>Absolute</LocMode><Dx>128</Dx><Dy>128</Dy><Pos>TopRight</Pos><StartTime>0</StartTime><EndTime>100.5</EndTime><Text><Text>水印内容</Text><FontSize>30</FontSize><FontType></FontType><FontColor>0xRRGGBB</FontColor><Transparency>30</Transparency></Text></Watermark><Watermark><Type>Image</Type><LocMode>Absolute</LocMode><Dx>128</Dx><Dy>128</Dy><Pos>TopRight</Pos><StartTime>0</StartTime><EndTime>100.5</EndTime><Image><Url>http://examplebucket-1250000000.ci.ap-beijing.myqcloud.com/shuiyin_2.png</Url><Mode>Proportion</Mode><Width>10</Width><Height>10</Height><Transparency>30</Transparency></Image></Watermark><Output><Region>ap-beijing</Region><Bucket>examplebucket-1250000000</Bucket><Object>test-trans.gif</Object></Output></Operation><QueueId>p893bcda225bf4945a378da6662e81a89</QueueId><CallBack>https://www.callback.com</CallBack></Request>
响应2
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 230Connection: keep-aliveDate: Thu, 15 Jun 2017 12:37:29 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response><JobsDetail><Code>Success</Code><Message>Success</Message><JobId>jabcxxxxfeipplsdfwe</JobId><State>Submitted</State><CreationTime>2019-07-07T12:12:12+0800</CreationTime><StartTime></StartTime><EndTime></EndTime><QueueId>p893bcda225bf4945a378da6662e81a89</QueueId><Tag>Transcode</Tag><Input><Object>test.mp4</Object></Input><Operation><Transcode><Container><Format>mp4</Format></Container><Video><Codec>H.264</Codec><Profile>high</Profile><Bitrate>1000</Bitrate><Crf></Crf><Width>1280</Width><Height></Height><Fps>30</Fps><Gop></Gop><Preset>medium</Preset><ScanMode></ScanMode><Bufsize>0</Bufsize><Maxrate>0</Maxrate></Video><Audio><Codec>aac</Codec><Samplerate>44100</Samplerate><Bitrate>128</Bitrate><Channels>4</Channels></Audio><TransConfig><AdjDarMethod>rescale</AdjDarMethod><IsCheckReso>false</IsCheckReso><ResoAdjMethod>1</ResoAdjMethod></TransConfig><TimeInterval><Start>0</Start><Duration>60</Duration></TimeInterval></Transcode><Watermark><Type>Text</Type><LocMode>Absolute</LocMode><Dx>128</Dx><Dy>128</Dy><Pos>TopRight</Pos><StartTime>0</StartTime><EndTime>100.5</EndTime><Text><Text>水印内容</Text><FontSize>30</FontSize><FontType></FontType><FontColor>0xRRGGBB</FontColor><Transparency>30</Transparency></Text></Watermark><Watermark><Type>Image</Type><LocMode>Absolute</LocMode><Dx>128</Dx><Dy>128</Dy><Pos>TopRight</Pos><StartTime>0</StartTime><EndTime>100.5</EndTime><Image><Url>http://examplebucket-1250000000.ci.ap-beijing.myqcloud.com/shuiyin_2.png</Url><Mode>Proportion</Mode><Width>10</Width><Height>10</Height><Transparency>30</Transparency></Image></Watermark><Output><Region>ap-beijing</Region><Bucket>examplebucket-1250000000</Bucket><Object>test-trans.mp4</Object></Output></Operation></JobsDetail></Response>