创建文档转换任务。支持文档格式转换，将存储在对象存储中的文档（Word、PPT、Excel、PDF）转成图片，文本，或者PDF。
接口说明
-
请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格
注意 异步任务不保证时效。 -
支持的输入文件格式：
- 文字文档（Word）：doc、docx、wps、wpss、docm、dotm、dot、dotx、html。
- 演示文档（PPT）：pptx、ppt、pot、potx、pps、ppsx、dps、dpt、pptm、potm、ppsm、dpss。
- 表格文档（Excel）：xls、xlt、et、ett、xlsx、xltx、csv、xlsb、xlsm、xltm、ets。
- PDF 文档：pdf。
-
支持的输出文件格式：
- 图片：png、jpg。
- 文本：txt。
- PDF：pdf。
-
单文件大小限制 200MB 以内。
-
支持最长的转换时间 120 秒，如果文件比较大或者文件内容本身比较复杂，可能会导致转换超时。
-
任务开始执行后，任务信息只保存 7 天，超过 7 天则无法再获取。您可以通过以下几种方式及时获取任务信息：
- 调用 GetTask 或 ListTasks 接口获取返回的
TaskId，查看任务信息。 - 在与智能媒体管理相同的地域下开通 MNS 服务，并配置订阅关系，及时获取任务信息通知，异步通知消息格式请参见异步通知消息格式。关于 MNS SDK 的更多信息，请参见接收和删除消息。
- 在与智能媒体管理相同的地域下开通 RocketMQ 服务，并创建 RocketMQ 4.0 实例、Topic、Group，及时获取任务信息通知，异步通知消息格式请参见异步通知消息格式。关于 RocketMQ 使用的更多信息，请参见快速使用 HTTP 协议的 SDK 收发普通消息。
- 在与智能媒体管理相同的地域下开通并接入事件总线 EventBridge服务，及时获取任务信息通知。更多信息，请参见智能媒体管理 IMM 事件。
- 调用 GetTask 或 ListTasks 接口获取返回的
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| imm:CreateOfficeConversionTask | create | *Project acs:imm:{#regionId}:{#accountId}:project/{#ProjectName} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectName | string | 是 | 项目名称，获取方式请参见创建项目。 | test-project |
| SourceURI | string | 否 | 源数据的存储地址。 OSS 地址规则为 oss://${Bucket}/${Object}，其中 | oss://test-bucket/test-object |
| TargetURI | string | 否 | 文档转换输出地址模板。 地址规则为 说明
和 TargetURIPrefix 二者至少需要填一个。
| oss://examplebucket/outputDocument.pdf |
| TargetURIPrefix | string | 否 | 文档转换后输出文件的存储地址前缀。 规则为 说明
和 TargetURI 二者至少需要填一个。
| oss://examplebucket/outputprefix/ |
| SourceType | string | 否 | 源数据的后缀类型。默认根据 OSS 对象的后缀名确定源数据的类型。当 OSS 对象没有后缀名时，可以设置此参数，可选值如下。
| doc |
| TargetType | string | 是 | 转换输出的目标文件类型。包括如下选项：
| png |
| UserData | string | 否 | 用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。 | { "id": "test-id", "name": "test-name" } |
| Tags | object | 否 | 自定义标签信息，字典格式。用于搜索任务。 | { "key": "value" } |
| StartPage | long | 否 | 文档转换的起始页，默认值为 1。 说明
| 1 |
| EndPage | long | 否 | 文档转换的结束页，默认值为-1，表示从起始页开始转换到最后一页。 说明
| -1 |
| Password | string | 否 | 文档的打开密码。如果需要转换有密码的文档，请设置此参数。 | 123456 |
| ScalePercentage | long | 否 | 文档缩放比例，取值范围为 20~200，默认值为 100，表示不缩放。 说明
小于 100 表示缩小，大于 100 表示放大。
| 100 |
| Quality | long | 否 | 转换文件的质量，取值范围为 0（质量最差，性能最好）~100（质量最好，性能最差）。默认情况下，系统会根据文档内容，在质量和性能中权衡，设置合适的值。 | 60 |
| Pages | string | 否 | 指定转换页码。优先级高于参数 StartPage 和参数 EndPage。格式如下：
| 1,2-4,7 |
| MaxSheetRow | long | 否 | 表格文档转换为图片的最大行数，默认转换所有行。 说明
当参数 LongPicture 取值为 true时，此参数生效。
| 10 |
| MaxSheetColumn | long | 否 | 表格文档转换为图片的最大列数，默认转换所有列。 说明
当参数 LongPicture 取值为 true时，此参数生效。
| 10 |
| SheetCount | long | 否 | 表格文档中转换为图片的工作表（sheet）的数量，默认转换所有工作表。 | 1 |
| SheetIndex | long | 否 | 表格文档中转换为图片的工作表（sheet）的页码，取值范围为 1~最后一个 sheet 页。默认转换起始页为 1。 | 1 |
| FitToWidth | boolean | 否 | 表格文档转换为图片或者 PDF 文件时，是否将所有列输出到一张图片或者 PDF 页面。取值范围如下：
| false |
| FitToHeight | boolean | 否 | 表格文档转换为图片或者 PDF 文件时，是否将所有行输出到一张图片或者 PDF 页面。取值范围如下：
| false |
| FirstPage | boolean | 否 | 表格文档转换为图片时，是否只返回转换结果的第一张图片（图片包含的行数和列数为自动切割的结果）。取值范围如下：
说明
仅当参数 LongPicture 取值为 true时，此参数生效。
| false |
| PaperSize | string | 否 | 表格文档转换为图片时的纸张大小（输出图片可以类比为在纸张上面打印）。取值范围如下：
说明
需配合参数 FitToHeight 和参数 FitToWidth 一起使用，此参数才能生效。
| A4 |
| PaperHorizontal | boolean | 否 | 表格文档转换为图片时纸张是否水平放置（输出图片可以类比为在纸张上面打印）。取值范围如下：
| false |
| TrimPolicy | TrimPolicy | 否 | 表格文档转换的瘦身策略。比如表格中有很多没有内容的行列，在没有瘦身策略的情况下，可能会输出很多空白。 | |
| ShowComments | boolean | 否 | 文字文档转换为图片时，是否显示批注。取值范围如下：
| false |
| LongPicture | boolean | 否 | 文档转换为图片时是否转换为一张长图。取值范围如下：
说明
最多支持将 20 页文档合成一张长图，超过该页数的转换任务可能会报错。
| false |
| ImageDPI | long | 否 | 输出图片 DPI，取值范围为 96~600，默认值为 96。 | 96 |
| LongText | boolean | 否 | 文档转换为文本时是否转换为长文本文件。取值范围如下：
| false |
| HoldLineFeed | boolean | 否 | 文档转换为文本时是否保留文档中的换行符。取值范围如下：
| false |
| CredentialConfig | CredentialConfig | 否 | 如无特殊需求，请保持留空即可。 链式授权配置，非必填。更多信息，请参见使用链式授权访问其他实体资源。 | |
| Notification | Notification | 否 | 消息通知配置，详细内容请单击 Notification 查看，异步通知消息格式请参见异步通知消息格式。 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "FF3B7D81-66AE-47E0-BF69-157DCF18*****",
"TaskId": "formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd*****",
"EventId": "2C2-1I0EG57VR37J4rQ8oKG6C9*****"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-11-29 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2024-10-18 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-04-03 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-03-09 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2022-08-16 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2022-08-16 | OpenAPI 入参发生变更 | 查看变更详情 |