tencent cloud

Submitting Tasks
Download PDF
Last updated: 2025-11-19 11:29:00
Submitting Tasks
Last updated: 2025-11-19 11:29:00
Download PDF

Feature Description

Submit an animated image job.

Authorization Description

When used by a sub-account, the ci:CreateMediaJobs permission is required. For details, see Cloud Infinite actions.
When a sub-account uses an asynchronous processing interface, the cam:passrole permission is required. The asynchronous processing interface performs COS resource read and write operations through the "role" in CAM. The PassRole permission is used for role passing. For details, see Access Management > Write Operations > PassRole Interface.

Service Activation

To use this feature, you need to enable Cloud Infinite in advance and bind a bucket. For details, see Bind Bucket.
Use this feature requires enabling the Media Processing Service in advance through the Console or API.

Use Limits

When using this API, please confirm the relevant restrictions first. For details, see Usage Limits.

Fee Description

This API is a paid service. The incurred fees will be collected by Cloud Infinite. For detailed billing instructions, see Media Processing Fee.


Request

Request sample

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 details, see Request Signature document.

Request header.

This API only uses common request headers. For details, see Common Request Headers documentation.

Request body.

The implementation of this request operation requires the following request 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>
The data are described as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Request
None.
Container for saving requests
Container
Yes
Specific data description for Container type
Request
is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Tag
Request
Tag for creating a task: Animation
String
Yes
Input
Request
File information to be operated
Container
Yes
Operation
Request
Operation rules
Container
Yes
CallBackFormat
Request
Job callback format, JSON or XML, default XML, priority is higher than the callback format of the queue
String
No
CallBackType
Request
Job callback type, Url or TDMQ, default Url, priority is higher than the callback type of the queue
String
No
CallBack
Request
job callback address, priority is higher than queue's callback address. When set to no, it indicates that the queue's callback address does not generate callbacks.
String
No
CallBackMqConfig
Request
Task callback TDMQ configuration, required when CallBackType is TDMQ. For details, see CallBackMqConfig.
Container
No
Specific data description for Container type Input is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Object
Request.Input
file path
String
Yes
Specific data description for Container type
Operation
is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
TemplateId
Request.Operation
video to GIF template ID
String
No
Animation
Request.Operation
video-to-GIF parameter
Container
No
Output
Request.Operation
Output configuration
Container
Yes
UserData
Request.Operation
Pass through user information, printable ASCII code, length not exceeding 1024
String
No
JobLevel
Request.Operation
Task priority, level limit: 0, 1, 2. Higher levels indicate higher task priority, default is 0.
String
No
Note:
Video-to-animated image conversion parameters must be set. They can be configured through TemplateId or Animation, with TemplateId having higher priority.
Specific data description for Container type Animation is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Container
Request.Operation.Animation
Same as the Request.Container in the Create Animated Image Template API.
Container
No
Video
Request.Operation.Animation
Same as the Request.Video in the Create Animated Image Template API.
Container
No
TimeInterval
Request.Operation.Animation
Same as the Request.TimeInterval in the Create Animated Image Template API.
Container
No
Specific data description for Container type Output is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Region
Request.Operation.Output
Region of the storage bucket
String
Yes
Bucket
Request.Operation.Output
Bucket for storing results
String
Yes
Object
Request.Operation.Output
Filename of the output result
String
Yes
Wildcard characters supported by Request.Operation.Output.Object are as follows:
Wildcard
Meaning
${ext}
Container format
${jobid}
Task Id

Response

Response Headers

This API only returns the public response header. For details, see Common Response Headers documentation.

Response Body

The response body is returned as application/xml. An example including the complete node data is shown below:
<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>
        <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>
The data are as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container for saving results
Container
Container node Response content:
Node Name (Keyword)
Parent Node
Description
Type
JobsDetail
Response
Task details
Container array
The content of Container node
JobsDetail
:
Node Name (Keyword)
Parent Node
Description
Type
Code
Response.JobsDetail
error code, which takes effect when State is Failed
String
Message
Response.JobsDetail
Error description. The error code description takes effect when the State is Failed.
String
JobId
Response.JobsDetail
Newly created task ID
String
Tag
Response.JobsDetail
Tag for the newly created task: Animation
String
State
Response.JobsDetail
Task Status
Submitted: pending execution
Running: in execution
Success: execution successful
Failed: execution failed
Pause: Task pause. When the pause queue is triggered, to-be-executed tasks will become paused state.
Cancel: Task execution cancelled
String
CreationTime
Response.JobsDetail
Task Creation Time
String
StartTime
Response.JobsDetail
Task Start Time
String
EndTime
Response.JobsDetail
Task End Time
String
QueueId
Response.JobsDetail
Task's Queue ID
String
Input
Response.JobsDetail
Input resource address of the task
Container
Operation
Response.JobsDetail
Rules of the task
Container
Content of the Container node Input:
Node Name (Keyword)
Parent Node
Description
Type
Region
Response.JobsDetail.Input
Region of the storage bucket
String
Bucket
Response.JobsDetail.Input
Bucket for storing results
String
Object
Response.JobsDetail.Input
Output result filename
String
Content of the Container node Operation:
Node Name (Keyword)
Parent Node
Description
Type
TemplateId
Response.JobsDetail.Operation
Task template ID
String
TemplateName
Response.JobsDetail.Operation
Task template name, return when TemplateId exists
String
Animation
Response.JobsDetail.Operation
Request.Operation.Animation
Container
Output
Response.JobsDetail.Operation
in-progress request's Request.Operation.Output
Container
MediaInfo
Response.JobsDetail.Operation
Output file's media information. Not returned if the task is not completed. For details, see MediaInfo.
Container
MediaResult
Response.JobsDetail.Operation
Basic information of the output file. Not returned if the task is not completed. For details, see MediaResult.
Container
UserData
Response.JobsDetail.Operation
Pass through user information
String
JobLevel
Response.JobsDetail.Operation
task priority
String

Error Codes

This request returns common error responses and error codes. For more information, see Error Codes.

Examples

Request: Use Animated Image Template ID

POST /jobs HTTP/1.1
Authorization: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.com
Content-Length: 166
Content-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>

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>j229ed9e2f60c11ec8525e36307395bf9</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <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>

Request: Processing Parameters Using Animated Graphics

POST /jobs HTTP/1.1
Authorization: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.com
Content-Length: 166
Content-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>

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>j229ed9e2f60c11ec8525e36307395bf9</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T15:23:12+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <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>

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback