文档服务
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 文档服务 > API 文档 > 文档转码 > 异步处理任务接口 > 提交文档转码任务

提交文档转码任务

最近更新时间：2023-09-19 15:04:46

前往 GitHub 编辑 我的收藏

本页目录：

功能描述

CreateDocProcessJobs 接口用于提交一个文档转码任务。

注意：

  • 目前支持的输入文件类型包含如下格式：
    • 演示文件：pptx、ppt、pot、potx、pps、ppsx、dps、dpt、pptm、potm、ppsm。
    • 文字文件：doc、dot、wps、wpt、docx、dotx、docm、dotm。
    • 表格文件：xls、xlt、et、ett、xlsx、xltx、csv、xlsb、xlsm、xltm、ets。
      表格文件，一张表可能分割为多页转换，生成多张图片。
    • 其他格式文件： pdf、 lrc、 c、 cpp、 h、 asm、 s、 java、 asp、 bat、 bas、 prg、 cmd、 rtf、 txt、 log、 xml、 htm、 html。
  • 输入文件大小限制在200M 之内。
  • 输入文件页数限制在5000页之内。
  • 任务记录保留一个月，请及时保存任务记录。建议配置回调进行任务结果查询。

请求

请求示例

POST /doc_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></Tag>
  <Input>
    <Object></Object>
  </Input>
  <Operation>
    <Output>
      <Region></Region>
      <Bucket></Bucket>
      <Object></Object>
    </Output>
    <DocProcess>
       <StartPage></StartPage>
       <EndPage></EndPage>
       <TgtType></TgtType>
    </DocProcess>
  </Operation>
  <QueueId></QueueId>
</Request>

具体的数据描述如下：

节点名称（关键字） 父节点 描述 类型 是否必选
Request 无 保存请求的容器 Container 是

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

节点名称（关键字） 父节点 描述 类型 是否必选
Tag Request 创建任务的 Tag，目前仅支持：DocProcess String 是
Input Request 待操作的文件对象 Container 是
Operation Request 操作规则 Container 是
QueueId Request 任务所在的队列 ID，开通预览服务后自动生成，请使用 查询队列 获取或前往 万象控制台 在存储桶中查询 String 是

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

节点名称（关键字） 父节点 描述 类型 是否必选
Object Request.Input 文件在 COS 上的文件路径，Bucket 由 Host 指定 String 是

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

节点名称（关键字） 父节点 描述 类型 是否必选
DocProcess Request.Operation 当 Tag 为 DocProcess 时有效，指定该任务的参数 Container 是
Output Request.Operation 结果输出地址 Container 是

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

通用请求参数

节点名称（关键字） 父节点 描述 类型 是否必选
SrcType Request.Operation.DocProcess 源数据的后缀类型，当前文档转换根据 cos 对象的后缀名来确定源数据类型，当 cos 对象没有后缀名时，可以设置该值 String 否
TgtType Request.Operation.DocProcess 转换输出目标文件类型：
  • jpg，转成 jpg 格式的图片文件；如果传入的格式未能识别，默认使用 jpg 格式
  • png，转成 png 格式的图片文件
  • pdf，转成 pdf 格式文件（暂不支持指定页数）
    		•  String 否
    StartPage Request.Operation.DocProcess 从第 X 页开始转换；在表格文件中，一张表可能分割为多页转换，生成多张图片。StartPage 表示从指定 SheetId 的第 X 页开始转换。默认为1 Int 否
    EndPage Request.Operation.DocProcess 转换至第 X 页；在表格文件中，一张表可能分割为多页转换，生成多张图片。EndPage 表示转换至指定 SheetId 的第 X 页。默认为-1，即转换全部页 Int 否

    适用于表格文件（Excel）的参数

    节点名称（关键字） 父节点 描述 类型 是否必选
    SheetId Request.Operation.DocProcess 表格文件参数，转换第 X 个表，默认为0；设置 SheetId 为0，即转换文档中全部表 Int 否
    PaperDirection Request.Operation.DocProcess 表格文件转换纸张方向，0代表垂直方向，非0代表水平方向，默认为0 Int 否
    PaperSize Request.Operation.DocProcess 设置纸张（画布）大小，对应信息为： 0 → A4 、 1 → A2 、 2 → A0 ，默认 A4 纸张 Int 否

    适用于转码成 png/jpg 图片的参数

    节点名称（关键字） 父节点 描述 类型 是否必选
    ImageParams Request.Operation.DocProcess 转换后的图片处理参数，支持 基础图片处理 所有处理参数，多个处理参数可通过 管道操作符 分隔，从而实现在一次访问中按顺序对图片进行不同处理 String 否
    Quality Request.Operation.DocProces 生成预览图的图片质量，取值范围 [1-100]，默认值100。 例：值为100，代表生成图片质量为100% Int 否
    Zoom Request.Operation.DocProces 预览图片的缩放参数，取值范围[10-200]， 默认值100。 例：值为200，代表图片缩放比例为200% 即放大两倍 Int 否
    ImageDpi Request.Operation.DocProcess 按指定 dpi 渲染图片，该参数与 Zoom 共同作用，取值范围 96-600 ，默认值为 96 。转码后的图片单边宽度需小于65500像素 Int 否
    PicPagination Request.Operation.DocProcess 是否转换成单张长图，设置为 1 时，最多仅支持将 20 标准页面合成单张长图，超过可能会报错，分页范围可以通过 StartPage、EndPage 控制。默认值为 0 ，按页导出图片，TgtType="png"/"jpg" 时生效 Int 否

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

    节点名称（关键字） 父节点 描述 类型 是否必选
    Region Request.Operation.Output 存储桶的地域 String 是
    Bucket Request.Operation.Output 存储结果的存储桶 String 是
    Object Request.Operation.Output 输出文件路径。
    非表格文件输出文件名需包含 ${Number} 或 ${Page} 参数。多个输出文件，${Number} 表示序号从1开始，${Page} 表示序号与预览页码一致。
  • ${Number} 表示多个输出文件，序号从1开始，例如输入 abc_${Number}.jpg，预览某文件5 - 6页，则输出文件名为 abc_1.jpg，abc_2.jpg
  • ${Page} 表示多个输出文件，序号与预览页码一致，例如输入 abc_${Page}.jpg，预览某文件5-6页，则输出文件名为 abc_5.jpg，abc_6.jpg
    表格文件输出路径需包含 ${SheetID} 占位符，输出文件名必须包含 ${Number} 参数。
  • 例如 /${SheetID}/abc_${Number}.jpg，先根据 excel 转换的表格数，生成对应数量的文件夹，再在对应的文件夹下，生成对应数量的图片文件
    		•  String 是

    响应

    响应头

    此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。

    响应体

    该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：

    <Response>
        <JobsDetail>
                <Code></Code>
                <CreationTime></CreationTime>
                <EndTime></EndTime>
                <Input>
                    <Object></Object>
                </Input>
                <JobId></JobId>
                <Message/>
                <Operation>
                    <DocProcess>
                        <SrcType></SrcType>
                        <TgtType></TgtType>
                        <StartPage></StartPage>
                        <EndPage></EndPage>
                        <ImageParams></ImageParams>
                    </DocProcess>
                    <Output>
                        <Bucket></Bucket>
                        <Object></Object>
                        <Region></Region>
                    </Output>
                </Operation>
                <QueueId></QueueId>
                <State></State>
                <Tag></Tag>
        </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：DocProcess String
    State Response.JobsDetail 任务的状态，为 Submitted、Running、Success、Failed、Pause、Cancel 其中一个 String
    CreationTime Response.JobsDetail 任务的创建时间 String
    QueueId Response.JobsDetail 任务所属的队列 ID String
    Input Response.JobsDetail 该任务的输入文件路径 Container
    Operation Response.JobsDetail 该任务的规则 Container

    Container 节点 Input 的内容：
    同上面请求中的 Request.Input 节点。

    Container 节点 Operation 的内容：

    节点名称（关键字） 父节点 描述 类型
    DocProcess Response.JobsDetail.Operation 文档预览任务参数 Container
    Output Response.JobsDetail.Operation 文件的输出地址 Container

    Container 节点 DocProcess 的内容：
    同上面请求中的 Request.Operation.DocProcess 节点。

    Container 节点 Output 的内容：
    同上面请求中的 Request.Operation.Output 节点。

    错误码

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

    实际案例

    请求

    POST /doc_jobs HTTP/1.1
Connection: keep-alive
Accept-Encoding: gzip, deflate
Accept: */*
User-Agent: cos-python-sdk-v5.3.2
Host: examplebucket-1250000000.ci.ap-chongqing.myqcloud.com
Content-Type: application/xml
Content-Length: 546
Authorization: Authorization

<?xml version="1.0" encoding="UTF-8" ?>

<Request>
    <Input>
        <Object>1.doc</Object>
    </Input>
    <Operation>
      <Output>
          <Region>ap-chongqing</Region>
          <Object>big/test-${Number}</Object>
          <Bucket>examplebucket-1250000000</Bucket>
      </Output>
      <DocProcess>
          <TgtType>png</TgtType>
          <StartPage>1</StartPage>
          <EndPage>-1</EndPage>
          <ImageParams>watermark/1/image/aHR0cDovL3Rlc3QwMDUtMTI1MTcwNDcwOC5jb3MuYXAtY2hvbmdxaW5nLm15cWNsb3VkLmNvbS8xLmpwZw==/gravity/southeast</ImageParams>
      </DocProcess>
    </Operation>
    <Tag>DocProcess</Tag>
    <QueueId>p532fdead78444e649e1a4467c1cd19d3</QueueId>
</Request>[!http]

    响应

    HTTP/1.1 200 OK
Date: Mon, 27 Jul 2020 07:20:08 GMT
Content-Type: application/xml
Content-Length: 863
Connection: keep-alive
Server: tencent-ci
x-ci-request-id: NWYxZTgwMjhfYzc2OTQzNjRfMzUx****

<?xml version="1.0" encoding="utf-8"?>
<Response>
        <JobsDetail>
                <Code>Success</Code>
                <CreationTime>2020-07-27T15:20:08+0800</CreationTime>
                <EndTime>-</EndTime>
                <Input>
                        <Object>1.doc</Object>
                </Input>
                <JobId>d99b3127ecfd911eab5e60dedb7c395dd</JobId>
                <Message/>
                <Operation>
                        <DocProcess>
                                <EndPage>5001</EndPage>
                                <ImageParams>watermark/1/image/aHR0cDovL3Rlc3QwMDUtMTI1MTcwNDcwOC5jb3MuYXAtY2hvbmdxaW5nLm15cWNsb3VkLmNvbS8xLmpwZw==/gravity/southeast</ImageParams>
                                <SrcType/>
                                <StartPage>1</StartPage>
                                <TgtType>png</TgtType>
                        </DocProcess>
                        <Output>
                                <Bucket>examplebucket-1250000000</Bucket>
                                <Object>big/test-${Number}</Object>
                                <Region>ap-chongqing</Region>
                        </Output>
                </Operation>
                <QueueId>p532fdead78444e649e1a4467c1cd19d3</QueueId>
                <State>Submitted</State>
                <Tag>DocProcess</Tag>
        </JobsDetail>
</Response>

    中国站