功能描述
提交一个动图任务。
授权说明
子账号使用异步处理接口时,需要授予 
cam:passrole 权限,异步处理接口会通过 CAM 的“角色”进行 COS 的资源读写操作,PassRole 权限用于传递角色, 具体请查看 访问管理 > 写操作 > PassRole 接口。服务开通
使用该功能需提前 绑定存储桶,开通数据万象服务。
注意:
数据万象绑定后,如果您手动对存储桶进行数据万象的解绑操作,将无法继续使用该功能。
使用限制
费用说明
请求
请求示例
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>Animation</Tag><Input><Object>input/demo.mp4</Object></Input><Operation><TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON</CallBackFormat></Request>
具体的数据描述如下:
| 节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 
| Request | 无 | 保存请求的容器 | Container | 是 | 
Container 类型 
Request
 的具体数据描述如下:| 节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 
| Tag | Request | 创建任务的 Tag:Animation | 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 | Container | 否 | 
Container 类型 Input 的具体数据描述如下:
| 节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 
| Object | Request.Input | 文件路径 | String | 是 | 
Container 类型 
Operation
 的具体数据描述如下:| 节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 
| TemplateId | Request.Operation | String | 否 | |
| Animation | Request.Operation | 视频转动图参数 | Container | 否 | 
| Output | Request.Operation | 结果输出配置 | Container | 是 | 
| UserData | Request.Operation | 透传用户信息,可打印的 ASCII 码,长度不超过1024 | String | 否 | 
| JobLevel | Request.Operation | 任务优先级,级别限制:0 、1 、2 。级别越大任务优先级越高,默认为0 | String | 否 | 
注意
视频转动图参数必须设置,可以通过 TemplateId 或 Animation 设置, TemplateId 优先级更高。
Container 类型 
Animation
 的具体数据描述如下:| 节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 
| Container | Request.Operation.Animation | Container | 否 | |
| Video | Request.Operation.Animation | Container | 否 | |
| TimeInterval | Request.Operation.Animation | Container | 否 | 
Container 类型 
Output
 的具体数据描述如下:| 节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 
| Region | Request.Operation.Output | 存储桶的地域 | String | 是 | 
| Bucket | Request.Operation.Output | 存储结果的存储桶 | String | 是 | 
| Object | Request.Operation.Output | 输出结果的文件名 | String | 是 | 
Request.Operation.Output.Object 支持的通配符如下:
| 通配符 | 含义 | 
| ${ext} | 封装格式 | 
| ${jobid} | 任务 Id | 
响应
响应头
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response><JobsDetail><Code>Success</Code><Message/><JobId>j229ed9e2f60c11ec8525e36307395bf9</JobId><State>Submitted</State><CreationTime>2022-06-27T15:23:10+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><QueueType>Transcoding</QueueType><Tag>Animation</Tag><Input><BucketId>test-123456789</BucketId><Object>input/demo.mp4</Object><Region>ap-chongqing</Region></Input><Operation><TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId><TemplateName>animation_demo</TemplateName><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></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:Animation | 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 | String | |
| QueueType | Response.JobsDetail | 任务所属的队列类型 | String | 
| Input | Response.JobsDetail | 该任务的输入资源地址 | Container | 
| Operation | Response.JobsDetail | 该任务的规则 | Container | 
Container 节点 Input 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 | 
| Region | Response.JobsDetail.Input | 存储桶的地域 | String | 
| BucketId | Response.JobsDetail.Input | 源文件所在存储桶 | String | 
| Object | Response.JobsDetail.Input | 源文件的文件名 | String | 
Container 节点 Operation 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 | 
| TemplateId | Response.JobsDetail.Operation | 任务的模板 ID | String | 
| TemplateName | Response.JobsDetail.Operation | 任务的模板名称, 当 TemplateId 存在时返回 | String | 
| Animation | Response.JobsDetail.Operation | Container | |
| Output | Response.JobsDetail.Operation | Container | |
| MediaInfo | Response.JobsDetail.Operation | Container | |
| MediaResult | Response.JobsDetail.Operation | Container | |
| UserData | Response.JobsDetail.Operation | 透传用户信息 | String | 
| JobLevel | Response.JobsDetail.Operation | 任务优先级 | String | 
错误码
实际案例
请求:使用动图模板 ID
POST /jobs HTTP/1.1Authorization:q-sign-algorithm=sha1&q-ak=************************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=****************************************Host:test-1234567890.ci.ap-chongqing.myqcloud.comContent-Length: 166Content-Type: application/xml<Request><Tag>Animation</Tag><Input><Object>input/demo.mp4</Object></Input><Operation><TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON</CallBackFormat></Request>
响应
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: NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=<Response><JobsDetail><Code>Success</Code><Message/><JobId>j229ed9e2f60c11ec8525e36307395bf9</JobId><State>Submitted</State><CreationTime>2022-06-27T15:23:10+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><QueueType>Transcoding</QueueType><Tag>Animation</Tag><Input><BucketId>test-123456789</BucketId><Object>input/demo.mp4</Object><Region>ap-chongqing</Region></Input><Operation><TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId><TemplateName>animation_demo</TemplateName><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>
请求:使用动图处理参数
POST /jobs HTTP/1.1Authorization:q-sign-algorithm=sha1&q-ak=************************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=****************************************Host:test-1234567890.ci.ap-chongqing.myqcloud.comContent-Length: 166Content-Type: application/xml<Request><Tag>Animation</Tag><Input><Object>input/demo.mp4</Object></Input><Operation><Animation><Container><Format>gif</Format></Container><Video><Codec>gif</Codec><Width>1280</Width><Height>960</Height><Fps>15</Fps><AnimateOnlyKeepKeyFrame>true</AnimateOnlyKeepKeyFrame></Video><TimeInterval><Start>0</Start><Duration>60</Duration></TimeInterval></Animation><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON</CallBackFormat></Request>
响应
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: NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=<Response><JobsDetail><Code>Success</Code><Message/><JobId>j229ed9e2f60c11ec8525e36307395bf9</JobId><State>Submitted</State><CreationTime>2022-06-27T15:23:12+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><QueueType>Transcoding</QueueType><Tag>Animation</Tag><Input><BucketId>test-123456789</BucketId><Object>input/demo.mp4</Object><Region>ap-chongqing</Region></Input><Operation><Animation><Container><Format>gif</Format></Container><Video><Codec>gif</Codec><Width>1280</Width><Height>960</Height><Fps>15</Fps><AnimateOnlyKeepKeyFrame>true</AnimateOnlyKeepKeyFrame></Video><TimeInterval><Start>0</Start><Duration>60</Duration></TimeInterval></Animation><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>