调用CreateOfficeConversionTask接口创建文档转换任务。

接口说明

任务开始执行后，任务信息只保存7天，超过7天则无法再获取。您可以通过以下三种方式及时获取任务信息：

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateOfficeConversionTask

操作接口名称，固定取值为CreateOfficeConversionTask。
ProjectName String 是 immtest

项目名称。
SourceURI String 是 oss://test-bucket/test-object

源数据的存储地址。

地址规则为oss://<bucket>/<object>，其中<bucket>为和当前项目处于同一地域的OSS Bucket名称，<object>为包含文件扩展名的文件完整路径。
TargetURI String 否 oss://{bucket}/{tags.custom}/{dirname}/{barename}.{autoext}

文档转换输出地址模板。

地址规则为oss://{bucket}/{tags.custom}/{dirname}/{barename}.{autoext}。更多信息，请参见TargetURI模板。
TargetURIPrefix String 否 oss://bucket1/

文档转换后输出文件的存储地址前缀。

规则为oss://<bucket>/<object>。其中<bucket>为和当前项目处于同一地域的OSS Bucket名称，<object>为不包含文件名称的文件路径。
SourceType String 否 doc

源数据的后缀类型。当OSS对象没有后缀名时，可以设置此参数。默认根据OSS对象的后缀名确定源数据的类型。
TargetType String 是 png

转换输出的目标文件类型。包括如下选项：

  • png：转换为PNG格式的图片文件。
  • jpg：转换为JPG格式的图片文件。
  • pdf：转换为PDF文件。
  • text：转换为只包含文本内容的文件，主要用于提取文件的文本内容。源数据类型只支持演示文档和文字文档。
NotifyTopicName String 否 topic1

异步反向通知的TopicName。
UserData String 否 {"file_id": "abc"}

用户自定义信息，此信息将在获取转换任务时原样返回。
Tags Map 否 {"test":"val1"}

自定义标签内容。
StartPage Long 否 1

文档转换的起始页，默认值为1。

说明 如果源文件为表格文档需要指定工作表页码（SheetIndex）。
EndPage Long 否 -1

文档转换的结束页，默认值为-1，表示转换所有页。

说明
  • 如果源文件为表格文档需要指定工作表页码（SheetIndex）。
  • 如果页码太多，建议分批转换，否则可能会导致转换超时。
Password String 否 ********

文档的打开密码。如果需要转换有密码的文档，请设置此参数。
ScalePercentage Long 否 100

文档缩放比例，取值范围为20~200，默认值为100，表示不缩放。

说明 小于100表示缩小，大于100表示放大。
Quality Long 否 60

转换文件的质量，取值范围为0（质量最差）~100（质量最好）。系统会默认选择合适的数值。
Pages String 否 1,2-4,7

指定转换页码。优先级高于参数StartPage和参数EndPage。格式如下：

  • 多个页码用半角逗号（,）隔开，例如1,2。
  • 连续页码用短划线（-）连接，例如1,2-4,7。
MaxSheetRow Long 否 10

表格文档转换为图片的最大行数，默认转换所有行。

说明 当参数LongPicture取值为true时，此参数生效。
MaxSheetColumn Long 否 10

表格文档转换为图片的最大列数，默认转换所有列。

说明 当参数LongPicture取值为true时，此参数生效。
SheetCount Long 否 1

表格文档中转换为图片的工作表（sheet）的数量，默认转换所有工作表。
SheetIndex Long 否 1

表格文档中转换为图片的工作表（sheet）的页码，取值范围为1~最后一个sheet页。默认转换起始页为1。
FitToWidth Boolean 否 false

表格文档转换为图片时，是否将所有列输出到一张图片。取值范围如下：

  • false（默认）：否
  • true：是
FitToHeight Boolean 否 false

表格文档转换为图片时，是否将所有行输出到一张图片。取值范围如下：

  • false（默认）：否
  • true：是
FirstPage Boolean 否 false

表格文档转换为图片时，是否只返回转换结果的第一张图片（图片包含的行数和列数为自动切割的结果）。取值范围如下：

  • false（默认）：否
  • true：是
说明 当参数LongPicture取值为true时，此参数生效。
PaperSize String 否 A4

表格文档转换为图片时的纸张大小。取值范围如下：

  • A0
  • A2
  • A4（默认）
说明 需配合参数FitToHeight和参数FitToWidth一起使用，此参数才能生效。
PaperHorizontal Boolean 否 false

表格文档转换为图片时纸张是否水平放置。取值范围如下：

  • false（默认）：否
  • true：是
TrimPolicy TrimPolicy 否

表格文档转换的瘦身策略。
ShowComments Boolean 否 false

文字文档转换为图片时，是否显示批注。取值范围如下：

  • false（默认）：否
  • true：是
LongPicture Boolean 否 false

文档转换为图片时是否转换为一张长图。取值范围如下：

  • false（默认）：否
  • true：是
说明 最多支持将20页文档合成一张长图，超过该页数的转换任务可能会报错。
ImageDPI Long 否 96

输出图片DPI，取值范围为96~600，默认值为96。
LongText Boolean 否 false

文档转换为文本时是否转换为长文本文件。取值范围如下：

  • false（默认）：否，每页文档转换为独立的文本文件
  • true：是
HoldLineFeed Boolean 否 false

文档转换为文本时是否保留文档中的换行符。取值范围如下：

  • false（默认）：否
  • true：是
CredentialConfig CredentialConfig 否

链式授权配置，非必填。更多信息，请参见使用链式授权访问其他实体资源。

返回数据

名称 类型 示例值 描述
RequestId String FF3B7D81-66AE-47E0-BF69-157DCF18*****

请求ID。
TaskId String formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd*****

任务ID。
EventId String 2C2-1I0EG57VR37J4rQ8oKG6C9*****

事件ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateOfficeConversionTask
&ProjectName=immtest
&SourceURI=oss://test-bucket/test-object
&TargetURI=oss://{bucket}/{tags.custom}/{dirname}/{barename}.{autoext}
&TargetURIPrefix=oss://bucket1/
&SourceType=doc
&TargetType=png
&NotifyTopicName=topic1
&UserData={"file_id": "abc"}
&StartPage=1
&EndPage=-1
&Password=********
&ScalePercentage=100
&Quality=60
&Pages=1,2-4,7
&MaxSheetRow=10
&MaxSheetColumn=10
&SheetCount=1
&SheetIndex=1
&FitToWidth=false
&FitToHeight=false
&FirstPage=false
&PaperSize=A4
&PaperHorizontal=false
&TrimPolicy={}
&ShowComments=false
&LongPicture=false
&ImageDPI=96
&LongText=false
&HoldLineFeed=false
&CredentialConfig={"Chain":[{}]}
&公共请求参数

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "FF3B7D81-66AE-47E0-BF69-157DCF18*****",
  "TaskId" : "formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd*****",
  "EventId" : "2C2-1I0EG57VR37J4rQ8oKG6C9*****"
}