tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
对象存储
    文档

    视频转动图

    最后更新时间：2023-05-06 17:35:34

      功能描述

      提交一个动图任务。

      请求

      请求示例

      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>
      说明：

      • Authorization: Auth String（详情请参见 请求签名 文档）。
      • 通过子账号使用时，需要授予相关的权限，详情请参见 授权粒度详情 文档。

      请求头

      此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。

      请求体

      该请求操作的实现需要有如下请求体。

      <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 任务回调TDMQ配置，当 CallBackType 为 TDMQ 时必填。详情见 CallBackMqConfig Container 否

      Container 类型 Input 的具体数据描述如下：

      节点名称（关键字） 父节点 描述 类型 是否必选
      Object Request.Input 文件路径 String 是


      Container 类型 Operation 的具体数据描述如下：

      节点名称（关键字） 父节点 描述 类型 是否必选
      Animation Request.Operation 该任务的参数 Container 否
      TemplateId Request.Operation 模板 ID String 否
      Output Request.Operation 结果输出配置 Container 是
      UserData Request.Operation 透传用户信息, 可打印的 ASCII 码, 长度不超过1024 String 否
      JobLevel Request.Operation 任务优先级，级别限制：0 、1 、2 。级别越大任务优先级越高，默认为0 String 否
      注意：

      优先使用 TemplateId，无 TemplateId 时使用 Animation。

      Container 类型 Animation 的具体数据描述如下：

      节点名称（关键字） 父节点 描述 类型 是否必选
      Container Request.Operation.Animation 同创建动图模板接口中的 Request.Container Container 否
      Video Request.Operation.Animation 同创建动图模板接口中的 Request.Video Container 否
      TimeInterval Request.Operation.Animation 同创建动图模板接口中的 Request.TimeInterval 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>
        <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 任务所属的队列 ID String
      Input Response.JobsDetail 该任务的输入资源地址 Container
      Operation Response.JobsDetail 该任务的规则 Container

      Container 节点 Input 的内容：

      节点名称（关键字） 父节点 描述 类型
      Region Response.JobsDetail.Input 存储桶的地域 String
      Bucket 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 同请求中的 Request.Operation.Animation Container
      Output Response.JobsDetail.Operation 同请求中的 Request.Operation.Output Container
      MediaInfo Response.JobsDetail.Operation 输出文件的媒体信息，任务未完成时不返回 Container
      MediaResult Response.JobsDetail.Operation 输出文件的基本信息，任务未完成时不返回 Container
      UserData Response.JobsDetail.Operation 透传用户信息 String
      JobLevel Response.JobsDetail.Operation 任务优先级 String

      Container 节点 MediaInfo 的内容：
      同 GenerateMediaInfo 接口中的 Response.MediaInfo 节点。

      Container 节点 MediaResult 的内容：
      详情见 MediaResult

      错误码

      该请求操作无特殊错误信息，常见的错误信息请参见 错误码 文档。

      实际案例

      使用动图模板 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>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 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>

      使用动图处理参数

      请求

      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>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 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>
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款