tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

MultiJobs

Last updated: 2024-02-27 15:52:05

    Feature Description

    This API is used to submit multiple jobs.
    

    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. For more information, see Common Request Headers.

    Request body

    This request requires the following request body:
    <Request>
        <Input>
            <Object>input/demo.mp4</Object>
        </Input>
        <Operation>
            <Tag>Animation</Tag>
            <TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/animation.gif</Object>
            </Output>
            <UserData>This is my Animation job.</UserData>
        </Operation>
        <Operation>
            <Tag>Transcode</Tag>
            <TemplateId>t1995d523e42df4c5e858f244b4174360c</TemplateId>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/transcode.mp4</Object>
            </Output>
            <UserData>This is my Trancode job.</UserData>
        </Operation>
        <Operation>
            <Tag>SmartCover</Tag>
            <SmartCover>
                <Format>jpg</Format>
                <Width>1280</Width>
                <Height>960</Height>
                <Count>5</Count>
                <DeleteDuplicates>true</DeleteDuplicates>
            </SmartCover>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/smartcover-${Number}.jpg</Object>
            </Output>   
            <UserData>This is my SmartCover job.</UserData>
        </Operation>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <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
    Input
    Request
    Information of the media file to be processed
    Container
    Yes
    Operation
    Request
    Operation rule. Up to six operation rules are supported.
    Container
    Yes
    QueueId
    Request
    Queue ID of the job
    String
    Yes
    Input has the following sub-nodes:
    Node Name (Keyword)
    Parent Node
    Description
    Type
    Required
    Object
    Request.Input
    Media filename
    String
    Yes
    The content of Operation varies by job type. For more information, see the following documents:
    Submitting Video Transcoding Job
    Submitting Video-to-Animated Image Conversion Job
    Submitting Screenshot Job
    Submitting Intelligent Thumbnail Job
    Submitting Video Splicing Job
    Submitting Voice/Sound Separation Job
    Submitting Video Montage Job
    Submitting SDR-to-HDR Job
    Submitting Video Enhancement Job
    Submitting Super Resolution Job
    Submitting Remuxing Job
    Submitting Digital Watermark Adding Job
    Submitting Digital Watermark Extracting Job
    Submitting Video Tagging Job
    Submitting Media Information Query Job
    Submitting Stream Separation Job
    Submitting Video Quality Scoring Job
    Submitting Text-to-Speech Job
    Submitting Audio Noise Cancellation Job

    Response

    Response headers

    This API only returns common response headers. For more information, see 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>j682b9662f84611ecb8546d80f2baf56f</JobId>
            <State>Submitted</State>
            <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
            <StartTime>-</StartTime>
            <EndTime>-</EndTime>
            <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
            <Input>
                <BucketId>test-123456789</BucketId>
                <Object>input/demo.mp4</Object>
                <Region>ap-chongqing</Region>
            </Input>
            <Operation>
                <Tag>Animation</Tag>
                <TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId>
                <TemplateName>animation_demo</TemplateName>
                <Output>
                    <Region>ap-chongqing</Region>
                    <Bucket>test-123456789</Bucket>
                    <Object>output/animation.gif</Object>
                </Output>
                <UserData>This is my Animation job.</UserData>
            </Operation>
        </JobsDetail>
        <JobsDetail>
            <Code>Success</Code>
            <Message/>
            <JobId>j68427030f84611ecb8546d80f2baf56f</JobId>
            <State>Submitted</State>
            <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
            <StartTime>-</StartTime>
            <EndTime>-</EndTime>
            <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
            <Input>
                <BucketId>test-123456789</BucketId>
                <Object>input/demo.mp4</Object>
                <Region>ap-chongqing</Region>
            </Input>
            <Operation>
                <Tag>Transcode</Tag>
                <TemplateId>t1995d523e42df4c5e858f244b4174360c</TemplateId>
                <TemplateName>transcode_demo</TemplateName>
                <Output>
                    <Region>ap-chongqing</Region>
                    <Bucket>test-123456789</Bucket>
                    <Object>output/transcode.mp4</Object>
                </Output>
                <UserData>This is my Trancode job.</UserData>
            </Operation>
        </JobsDetail>
        <JobsDetail>
            <Code>Success</Code>
            <Message/>
            <JobId>j6842765cf84611ecb8546d80f2baf56f</JobId>
            <State>Submitted</State>
            <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
            <StartTime>-</StartTime>
            <EndTime>-</EndTime>
            <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
            <Input>
                <BucketId>test-123456789</BucketId>
                <Object>input/demo.mp4</Object>
                <Region>ap-chongqing</Region>
            </Input>
            <Operation>
                <Tag>SmartCover</Tag>
                <SmartCover>
                    <Format>jpg</Format>
                    <Width>1280</Width>
                    <Height>960</Height>
                    <Count>5</Count>
                    <DeleteDuplicates>true</DeleteDuplicates>
                </SmartCover>
                <Output>
                    <Region>ap-chongqing</Region>
                    <Bucket>test-123456789</Bucket>
                    <Object>output/smartcover-${Number}.jpg</Object>
                </Output>   
                <UserData>This is my SmartCover job.</UserData>
            </Operation>
        </JobsDetail>
    </Response>
    The nodes are as described below:
    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
    Job details
    Container array
    The content of JobsDetail varies by job type. For more information, see the following documents:
    Submitting Video Transcoding Job
    Submitting Video-to-Animated Image Conversion Job
    Submitting Video Frame Capturing Job
    Submitting Intelligent Thumbnail Job
    Submitting Video Splicing Job
    Submitting Voice/Sound Separation Job
    Submitting Video Montage Job
    Submitting SDR-to-HDR Job
    Submitting Video Enhancement Job
    Submitting Super Resolution Job
    Submitting Remuxing Job
    Submitting Digital Watermark Adding Job
    Submitting Digital Watermark Extracting Job
    Submitting Video Tagging Job
    Submitting Media Information Query Job
    Submitting Stream Separation Job
    Submitting Video Quality Scoring Job
    Submitting Text-to-Speech Job
    Submitting Audio Noise Cancellation Job

    Error codes

    There are no special error messages for this request. For common error messages, see Error Codes.

    Samples

    Using multiple template IDs

    Request

    POST /jobs HTTP/1.1
    Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0**********&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057
    Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
    Content-Length: 166
    Content-Type: application/xml
    
    <Request>
        <Input>
            <Object>input/demo.mp4</Object>
        </Input>
        <Operation>
            <Tag>Animation</Tag>
            <TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/animation.gif</Object>
            </Output>
            <UserData>This is my Animation job.</UserData>
        </Operation>
        <Operation>
            <Tag>Transcode</Tag>
            <TemplateId>t1995d523e42df4c5e858f244b4174360c</TemplateId>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/transcode.mp4</Object>
            </Output>
            <UserData>This is my Trancode job.</UserData>
        </Operation>
        <Operation>
            <Tag>SmartCover</Tag>
            <SmartCover>
                <Format>jpg</Format>
                <Width>1280</Width>
                <Height>960</Height>
                <Count>5</Count>
                <DeleteDuplicates>true</DeleteDuplicates>
            </SmartCover>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/smartcover-${Number}.jpg</Object>
            </Output>   
            <UserData>This is my SmartCover job.</UserData>
        </Operation>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <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: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
    
    <Response>
        <JobsDetail>
            <Code>Success</Code>
            <Message/>
            <JobId>j682b9662f84611ecb8546d80f2baf56f</JobId>
            <State>Submitted</State>
            <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
            <StartTime>-</StartTime>
            <EndTime>-</EndTime>
            <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
            <Input>
                <BucketId>test-123456789</BucketId>
                <Object>input/demo.mp4</Object>
                <Region>ap-chongqing</Region>
            </Input>
            <Operation>
                <Tag>Animation</Tag>
                <TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId>
                <TemplateName>animation_demo</TemplateName>
                <Output>
                    <Region>ap-chongqing</Region>
                    <Bucket>test-123456789</Bucket>
                    <Object>output/animation.gif</Object>
                </Output>
                <UserData>This is my Animation job.</UserData>
            </Operation>
        </JobsDetail>
        <JobsDetail>
            <Code>Success</Code>
            <Message/>
            <JobId>j68427030f84611ecb8546d80f2baf56f</JobId>
            <State>Submitted</State>
            <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
            <StartTime>-</StartTime>
            <EndTime>-</EndTime>
            <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
            <Input>
                <BucketId>test-123456789</BucketId>
                <Object>input/demo.mp4</Object>
                <Region>ap-chongqing</Region>
            </Input>
            <Operation>
                <Tag>Transcode</Tag>
                <TemplateId>t1995d523e42df4c5e858f244b4174360c</TemplateId>
                <TemplateName>trancode_demo</TemplateName>
                <Output>
                    <Region>ap-chongqing</Region>
                    <Bucket>test-123456789</Bucket>
                    <Object>output/transcode.mp4</Object>
                </Output>
                <UserData>This is my Trancode job.</UserData>
            </Operation>
        </JobsDetail>
        <JobsDetail>
            <Code>Success</Code>
            <Message/>
            <JobId>j6842765cf84611ecb8546d80f2baf56f</JobId>
            <State>Submitted</State>
            <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
            <StartTime>-</StartTime>
            <EndTime>-</EndTime>
            <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
            <Input>
                <BucketId>test-123456789</BucketId>
                <Object>input/demo.mp4</Object>
                <Region>ap-chongqing</Region>
            </Input>
            <Operation>
                <Tag>SmartCover</Tag>
                <SmartCover>
                    <Format>jpg</Format>
                    <Width>1280</Width>
                    <Height>960</Height>
                    <Count>5</Count>
                    <DeleteDuplicates>true</DeleteDuplicates>
                </SmartCover>
                <Output>
                    <Region>ap-chongqing</Region>
                    <Bucket>test-123456789</Bucket>
                    <Object>output/smartcover-${Number}.jpg</Object>
                </Output>   
                <UserData>This is my SmartCover job.</UserData>
            </Operation>
        </JobsDetail>
    </Response>
    
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy