接口说明
-
请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格
注意 异步任务不保证时效。 -
支持的输入文件格式：
- 文字文档（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 接口获取返回的
流控信息
请求参数
| 字段名称 | 字段详情 |
|---|---|
ProjectNamestring | 项目名称，获取方式请参见创建项目。 示例值:test-project参考取值来源: CreateProject UpdateProject ListProjects |
SourceURIstring | 源数据的存储地址。展开详情 示例值:oss://test-bucket/test-object |
Sourcesarray<object> | |
TargetURIstring | 文档转换输出地址模板。展开详情 示例值:oss://examplebucket/outputDocument.pdf参考取值来源: CreateImageToPDFTask |
TargetURIPrefixstring | 文档转换后输出文件的存储地址前缀。展开详情 示例值:oss://examplebucket/outputprefix/ |
SourceTypestring | 源数据的后缀类型。默认根据 OSS 对象的后缀名确定源数据的类型。当 OSS 对象没有后缀名时，可以设置此参数，可选值如下。展开详情 示例值:doc |
TargetTypestring | 转换输出的目标文件类型。包括如下选项：展开详情 示例值:png |
UserDatastring | 用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。 示例值:{
"id": "test-id",
"name": "test-name"
} |
Tagsobject | 自定义标签信息，字典格式。用于搜索任务。 示例值:{
"key": "value"
} |
StartPageinteger<int64> | |
EndPageinteger<int64> | 文档转换的结束页，默认值为-1，表示从起始页开始转换到最后一页。展开详情 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:-1 |
Passwordstring | 文档的打开密码。如果需要转换有密码的文档，请设置此参数。 示例值:123456 |
ScalePercentageinteger<int64> | 文档缩放比例，取值范围为 20~200，默认值为 100，表示不缩放。展开详情 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:100 |
Qualityinteger<int64> | 转换文件的质量，取值范围为 0（质量最差，性能最好）~100（质量最好，性能最差）。默认情况下，系统会根据文档内容，在质量和性能中权衡，设置合适的值。 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:60 |
Pagesstring | 指定转换页码。优先级高于参数 StartPage 和参数 EndPage。格式如下：展开详情 示例值:1,2-4,7 |
MaxSheetRowinteger<int64> | |
MaxSheetColumninteger<int64> | |
SheetCountinteger<int64> | 表格文档中转换为图片的工作表（sheet）的数量，默认转换所有工作表。 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:1 |
SheetIndexinteger<int64> | 表格文档中转换为图片的工作表（sheet）的页码，取值范围为 1~最后一个 sheet 页。默认转换起始页为 1。 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:1 |
FitToWidthboolean | 表格文档转换为图片或者 PDF 文件时，是否将所有列输出到一张图片或者 PDF 页面。取值范围如下：展开详情 示例值:false |
FitToHeightboolean | 表格文档转换为图片或者 PDF 文件时，是否将所有行输出到一张图片或者 PDF 页面。取值范围如下：展开详情 示例值:false |
FirstPageboolean | 表格文档转换为图片时，是否只返回转换结果的第一张图片（图片包含的行数和列数为自动切割的结果）。取值范围如下：展开详情 示例值:false |
PaperSizestring | 表格文档转换为图片时的纸张大小（输出图片可以类比为在纸张上面打印）。取值范围如下：展开详情 示例值:A4 |
PaperHorizontalboolean | 表格文档转换为图片时纸张是否水平放置（输出图片可以类比为在纸张上面打印）。取值范围如下：展开详情 示例值:false |
文档转换表格瘦身参数对象。 | |
ShowCommentsboolean | 文字文档转换为图片时，是否显示批注。取值范围如下：展开详情 示例值:false |
LongPictureboolean | 文档转换为图片时是否转换为一张长图。取值范围如下：展开详情 示例值:false |
ImageDPIinteger<int64> | 输出图片 DPI，取值范围为 96~600，默认值为 96。 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:96 |
LongTextboolean | 文档转换为文本时是否转换为长文本文件。取值范围如下：展开详情 示例值:false |
HoldLineFeedboolean | 文档转换为文本时是否保留文档中的换行符。取值范围如下：展开详情 示例值:false |
链式授权配置对象，一般留空即可。展开详情 | |
返回参数
| 字段名称 | 字段详情 |
|---|---|
RequestIdstring | 请求 ID。 示例值:FF3B7D81-66AE-47E0-BF69-157DCF18***** |
TaskIdstring | 任务 ID。 示例值:formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd***** |
EventIdstring | 事件 ID。 示例值:2C2-1I0EG57VR37J4rQ8oKG6C9***** |
返回示例
变更历史
| 变更时间 | 变更内容概要 | 操作 | |
|---|---|---|---|
| 2024-11-29 | |||
| 2024-10-18 | |||
| 2023-04-03 | |||
| 2023-03-09 | |||
| 2022-08-16 | |||
| 2022-04-26 |