This API (Create Media Jobs
) is used to submit a screenshot task.
POST /jobs HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml
<body>
Note:Authorization: Auth String (For more information, please see Request Signature.)
This API only uses Common Request Headers.
This request requires the following request body:
<Request>
<Tag>Snapshot</Tag>
<Input>
<Object></Object>
</Input>
<Operation>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<Output>
<Region></Region>
<Bucket></Bucket>
<Object></Object>
</Output>
</Operation>
<QueueId></QueueId>
<CallBack></CallBack>
</Request>
The nodes are described as follows:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
Request | None | Request container | Container | Yes |
Request
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
Tag | Request | Task type. Valid values: Transcode (transcoding), Animation (animated image), SmartCover (smart cover), Snapshot (screenshot), Concat (concatenation) |
String | Yes |
Input | Request | Information about the media to be operated | Container | Yes |
Operation | Request | Operation rule. Up to 6 operation rules are supported. | Container | Yes |
QueueId | Request | ID of the queue where the task is in | String | Yes |
CallBack | Request | Callback address | String | Yes |
Input
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
Object | Request.Input | Media filename | String | Yes |
Operation
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
Snapshot | Request.Operation | Task type parameter. Same as Request.Snapshot in the screenshot template creation API CreateMediaTemplate . |
Container | No |
TemplateId | Request.Operation | Template ID | String | No |
Output | Request.Operation | Result output address | Container | Yes |
Note:
TemplateId
is used with priority. IfTemplateId
is unavailable, the corresponding task type parameter is used.
Output
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
Region | Request.Operation.Output | Bucket region | String | Yes |
Bucket | Request.Operation.Output | Result storage bucket | String | Yes |
Object | Request.Operation.Output | Result file name. **If the task type is Snapshot , ${Number} must be included in the file name. **For example, you can set Object to snapshot-${Number}.jpg . |
String | Yes |
This API only returns Common Response Headers.
The response body returns application/xml data. The following contains all the nodes:
<Response>
<JobsDetail>
<Code></Code>
<Message></Message>
<JobId></JobId>
<State></State>
<CreationTime></CreationTime>
<EndTime></EndTime>
<QueueId></QueueId>
<Tag>Snapshot</Tag>
<Input>
<Object></Object>
</Input>
<Operation>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<Output>
<Region></Region>
<Bucket></Bucket>
<Object></Object>
</Output>
<MediaInfo>
</MeidaInfo>
</Operation>
</JobsDetail>
</Response>
The nodes are described as follows:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
Response | None | Response container | Container |
Response
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
JobsDetail | Response | Task details | Container |
JobsDetail
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
Code | Response.JobsDetail | Error code, which is meaningful only if State is Failed |
String |
Message | Response.JobsDetail | Error description, which is meaningful only if State is Failed |
String |
JobId | Response.JobsDetail | Task ID | String |
Tag | Response.JobsDetail | Task type. Valid values: Transcode (transcoding), Animation (animated image), SmartCover (smart cover), Snapshot (screenshot), Concat (concatenation) |
String |
State | Response.JobsDetail | Task status. Valid values: Submitted , Running , Success , Failed , Pause , Cancel |
String |
CreationTime | Response.JobsDetail | Task creation time | String |
EndTime | Response.JobsDetail | Task end time | String |
QueueId | Response.JobsDetail | ID of the queue where the task is in | String |
Input | Response.JobsDetail | Input resource address of the task | Container |
Operation | Response.JobsDetail | Operation rule. Up to 6 operation rules are supported. | Container |
Input
has the following sub-nodes:
Same as the Request.Input
node in the request.
Operation
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
TemplateId | Response.JobsDetail.Operation | Task template ID | String |
Output | Response.JobsDetail.Operation | File output address | Container |
MediaInfo | Response.JobsDetail.Operation | Transcoding output video information. Not returned when there is no output video. | Container |
Output
has the following sub-nodes:
Same as the Request.Operation.Output
node in the request.
MediaInfo
has the following sub-nodes:
Same as the Response.MediaInfo
node in the GenerateMediaInfo
API.
No special error message will be returned for this request. For the common error messages, please see Error Codes.
Using the screenshot template ID
POST /jobs HTTP/1.1
Authorization: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=28e9a4986df11bed0255e97ff90500557e0ea057
Host:bucket-1250000000.ci.ap-beijing.myqcloud.com
Content-Length: 166
Content-Type: application/xml
<Request>
<Tag>Snapshot</Tag>
<Input>
<Object>test.mp4</Object>
</Input>
<Operation>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<Output>
<Region>ap-beijing</Region>
<Bucket>abc-1250000000</Bucket>
<Object>snapshot-${Number}.jpg</Object>
</Output>
</Operation>
<QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
<CallBack>https://www.callback.com</CallBack>
</Request>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=
<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>Snapshot</Tag>
<Input>
<Object>test.mp4</Object>
</Input>
<Operation>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<Output>
<Region>ap-beijing</Region>
<Bucket>abc-1250000000</Bucket>
<Object>snapshot-${Number}.jpg</Object>
</Output>
</Operation>
</JobsDetail>
</Response>
Using the screenshot processing parameter
POST /jobs HTTP/1.1
Authorization: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=28e9a4986df11bed0255e97ff90500557e0ea057
Host:bucket-1250000000.ci.ap-beijing.myqcloud.com
Content-Length: 166
Content-Type: application/xml
<Request>
<Tag>Snapshot</Tag>
<Input>
<Object>test.mp4</Object>
</Input>
<Operation>
<Snapshot>
<Mode>Interval</Mode>
<Width>1280</Width>
<Height></Height>
<Start>0</Start>
<TimeInterval></TimeInterval>
<Count>1</Count>
</Snapshot>
<Output>
<Region>ap-beijing</Region>
<Bucket>abc-1250000000</Bucket>
<Object>snapshot-${Number}.jpg</Object>
</Output>
</Operation>
<QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
<CallBack>https://www.callback.com</CallBack>
</Request>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=
<Response>
<JobsDetail>
<Code>Success</Code>
<Message>Success</Message>
<JobId>jabcxxxxfeipplsdfwe</JobId>
<State>Submitted</State>
<CreationTime>2019-07-07T12:12:12+0800</CreationTime>
<EndTime></EndTime>
<QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
<Tag>Snapshot</Tag>
<Input>
<Object>test.mp4</Object>
</Input>
<Operation>
<Snapshot>
<Mode>Interval</Mode>
<Width>1280</Width>
<Height></Height>
<Start>0</Start>
<TimeInterval></TimeInterval>
<Count>1</Count>
</Snapshot>
<Output>
<Region>ap-beijing</Region>
<Bucket>abc-1250000000</Bucket>
<Object>snapshot-${Number}.jpg</Object>
</Output>
</Operation>
</JobsDetail>
</Response>
Was this page helpful?