Submitting Screenshot Job

Last updated: 2024-06-12 15:36:13
Feature Overview
This API is used to submit a screenshot job.
Request
Sample request
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, see Request Signature.
When this feature is used by a sub-account, relevant permissions must be granted as instructed in Authorization Granularity Details.
Request headers
This API only uses Common Request Headers.
Request body
This request requires the following request body:
<Request>
    <Tag>Snapshot</Tag>
    <Input>
        <Object>input/demo.mp4</Object>
    </Input>
    <Operation>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <Output>
            <Region>ap-chongqing</Region>
            <Bucket>test-123456789</Bucket>
            <Object>output/snapshot-${number}.jpg</Object>
            <SpriteObject>output/sprite-${number}.jpg</SpriteObject>
        </Output>
        <UserData>This is my data.</UserData>
        <JobLevel>0</JobLevel>
    </Operation>
    <CallBack>http://callback.demo.com</CallBack>
    <CallBackFormat>JSON<CallBackFormat>
</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
Job type: Snapshot
String
Yes
Input
Request
Information about the file to be operated
Container
Yes
Operation
Request
Operation rule
Container
Yes
CallBackFormat
Request
Job callback format, which can be JSON or XML (default value). It takes priority over that of the queue.
String
No
CallBackType
Request
Job callback type, which can be Url (default value) or TDMQ. It takes priority over that of the queue.
String
No
CallBack
Request
Job callback address, which takes priority over that of the queue. If it is set to no, no callbacks will be generated at the callback address of the queue.
String
No
CallBackMqConfig
Request
TDMQ configuration for job callback as described in Structure, which is required if CallBackType is TDMQ.
Container
No
Input has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
Required
Object
Request.Input
File path
String
Yes
﻿Operation
 has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
Required
Snapshot
Request.Operation
Job parameter, which is the same as Request.Snapshot
 in the screenshot template creation API
Container
No
TemplateId
Request.Operation
Template ID
String
No
Output
Request.Operation
Result output configuration
Container
Yes
UserData
Request.Operation
The user information passed through, which is printable ASCII codes of up to 1,024 in length.
String
No
JobLevel
Request.Operation
Job priority. The greater the value, the higher the priority. Valid values: 0 (default), 1, 2.
String
No
Note: 
TemplateId is used first. If TemplateId is unavailable, Snapshot 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 filename. If there are multiple output files, the ${number} wildcard must be contained.
String
No
SpriteObject
Request.Operation.Output
Image sprite name. If there are multiple output files, the ${number} wildcard must be contained. Only JPG is supported.
String
No
Request.Operation.Output.Object and Request.Operation.Output.SpriteObject support the following wildcards:
Wildcard
Description
${ext}
Container format
${jobid}
Job ID
${number}
Output index, starting from 0
${time}
Screenshot time point in milliseconds
Response
Response headers
This API only returns Common Response Headers.
Response body
The response body returns application/xml data. The following contains all the nodes:
<Response>
    <JobsDetail>
        <Code>Success</Code>
        <Message/>
        <JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <Tag>Snapshot</Tag>
        <Input>
            <BucketId>test-123456789</BucketId>
            <Object>input/demo.mp4</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <Operation>
            <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
            <TemplateName>snapshot_demo</TemplateName>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/snapshot-${number}.jpg</Object>
                <SpriteObject>output/sprite-${number}.jpg</SpriteObject>
            </Output>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
        </Operation>
    </JobsDetail>
</Response>
The nodes are as described below:
Node Name (Keyword)
Parent Node
Description
Type
Response
None
Result storage container
Container
Response has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
JobsDetail
Response
Job details
Container
﻿JobsDetail
 has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
Code
Response.JobsDetail
Error code, which is returned only if State is Failed
String
Message
Response.JobsDetail
Error message, which is returned only if State is Failed
String
JobId
Response.JobsDetail
Job ID
String
Tag
Response.JobsDetail
Job type: Snapshot
String
State
Response.JobsDetail
Job status. Valid values: Submitted, Running, Success, Failed, Pause, Cancel.
String
CreationTime
Response.JobsDetail
Job creation time
String
StartTime
Response.JobsDetail
Job start time
String
EndTime
Response.JobsDetail
Job end time
String
QueueId
Response.JobsDetail
ID of the queue where the job is in
String
Input
Response.JobsDetail
Input resource address of the job
Container
Operation
Response.JobsDetail
Operation rule
Container
Input has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
Region
Response.JobsDetail.Input
Bucket region
String
Bucket
Response.JobsDetail.Input
Result storage bucket
String
Object
Response.JobsDetail.Input
Output result filename
String
Operation has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
TemplateId
Response.JobsDetail.Operation
Job template ID
String
TemplateName
Response.JobsDetail.Operation
Job template name, which is returned when TemplateId exists
String
Snapshot
Response.JobsDetail.Operation
Same as Request.Operation.Snapshot in the request
Container
Output
Response.JobsDetail.Operation
Same as Request.Operation.Output in the request
Container
MediaResult
Response.JobsDetail.Operation
Basic information of the output file, which will not be returned when the job is not completed
Container
UserData
Response.JobsDetail.Operation
The user information passed through
String
JobLevel
Response.JobsDetail.Operation
Job priority
String
MediaResult has the following sub-nodes:
For more information, see MediaResult.
Error codes
No special error message will be returned for this request. For the common error messages, see Error Codes.
Examples
Request 1: Using a 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:test-1234567890.ci.ap-chongqing.myqcloud.com
Content-Length: 166
Content-Type: application/xml
﻿
<Request>
    <Tag>Snapshot</Tag>
    <Input>
        <Object>input/demo.mp4</Object>
    </Input>
    <Operation>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <Output>
            <Region>ap-chongqing</Region>
            <Bucket>test-123456789</Bucket>
            <Object>output/snapshot-${number}.jpg</Object>
            <SpriteObject>output/sprite-${number}.jpg</SpriteObject>
        </Output>
        <UserData>This is my data.</UserData>
        <JobLevel>0</JobLevel>
    </Operation>
    <CallBack>http://callback.demo.com</CallBack>
    <CallBackFormat>JSON<CallBackFormat>
</Request>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Mon, 28 Jun 2022 15:23:12 GMT
Server: tencent-ci
x-ci-request-id: NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=
﻿
<Response>
    <JobsDetail>
        <Code>Success</Code>
        <Message/>
        <JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <Tag>Snapshot</Tag>
        <Input>
            <BucketId>test-123456789</BucketId>
            <Object>input/demo.mp4</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <Operation>
            <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
            <TemplateName>snapshot_demo</TemplateName>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/snapshot-${number}.jpg</Object>
                <SpriteObject>output/sprite-${number}.jpg</SpriteObject>
            </Output>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
        </Operation>
    </JobsDetail>
</Response>
Request 2: 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:test-1234567890.ci.ap-chongqing.myqcloud.com
Content-Length: 166
Content-Type: application/xml
﻿
<Request>
    <Tag>Snapshot</Tag>
    <Input>
        <Object>input/demo.mp4</Object>
    </Input>
    <Operation>
        <Snapshot>
            <BlackLevel>0</BlackLevel>
            <Count>10</Count>
            <IsCheckBlack>false</IsCheckBlack>
            <IsCheckCount>false</IsCheckCount>
            <Mode>Interval</Mode>
            <PixelBlackThreshold>0</PixelBlackThreshold>
            <SnapshotOutMode>SnapshotAndSprite</SnapshotOutMode>
            <SpriteSnapshotConfig>
                <Color>Azure</Color>
                <Columns>3</Columns>
                <Lines>2</Lines>
            </SpriteSnapshotConfig>
            <Start>1</Start>
            <TimeInterval>2</TimeInterval>
        </Snapshot>
        <Output>
            <Region>ap-chongqing</Region>
            <Bucket>test-123456789</Bucket>
            <Object>output/snapshot-${number}.jpg</Object>
            <SpriteObject>output/sprite-${number}.jpg</SpriteObject>
        </Output>
        <UserData>This is my data.</UserData>
        <JobLevel>0</JobLevel>
    </Operation>
    <CallBack>http://callback.demo.com</CallBack>
    <CallBackFormat>JSON<CallBackFormat>
</Request>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Mon, 28 Jun 2022 15:23:12 GMT
Server: tencent-ci
x-ci-request-id: NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=
﻿
<Response>
    <JobsDetail>
        <Code>Success</Code>
        <Message/>
        <JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <Tag>Snapshot</Tag>
        <Input>
            <BucketId>test-123456789</BucketId>
            <Object>input/demo.mp4</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <Operation>
            <Snapshot>
                <BlackLevel>0</BlackLevel>
                <Count>10</Count>
                <IsCheckBlack>false</IsCheckBlack>
                <IsCheckCount>false</IsCheckCount>
                <Mode>Interval</Mode>
                <PixelBlackThreshold>0</PixelBlackThreshold>
                <SnapshotOutMode>SnapshotAndSprite</SnapshotOutMode>
                <SpriteSnapshotConfig>
                    <Color>Azure</Color>
                    <Columns>3</Columns>
                    <Lines>2</Lines>
                </SpriteSnapshotConfig>
                <Start>1</Start>
                <TimeInterval>2</TimeInterval>
            </Snapshot>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/snapshot-${number}.jpg</Object>
                <SpriteObject>output/sprite-${number}.jpg</SpriteObject>
            </Output>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
        </Operation>
    </JobsDetail>
</Response>
﻿
tencent cloud

Recent Pages

Submitting Screenshot Job

Feature Overview

Request

Sample request

Request headers

Request body

Response

Response headers

Response body

Error codes

Examples

Request 1: Using a screenshot template ID

Response

Request 2: Using the screenshot processing parameter

Response

Was this page helpful?

Was this page helpful?

Node Name (Keyword)	Parent Node	Description	Type	Required
Request	None	Request container	Container	Yes
Wildcard	Description
${ext}	Container format
${jobid}	Job ID
${number}	Output index, starting from 0
${time}	Screenshot time point in milliseconds
tencent cloud

Sign Up

Log in

Recent Pages

Submitting Screenshot Job

Feature Overview

Request

Sample request

Request headers

Request body

Response

Response headers

Response body

Error codes

Examples

Request 1: Using a screenshot template ID

Response

Request 2: Using the screenshot processing parameter

Response

Was this page helpful?

Was this page helpful?
