采用异步请求方式进行文档（例如Office文档）格式的转换，执行完成后返回TaskId。
接口说明
- 此接口已不再维护，建议使用新版（2020-09-30 版本）接口 CreateOfficeConversionTask 。关于新版与旧版 API 的对比，请参见新旧版本使用指引中的新版与旧版 API 对应关系说明章节。
- 执行完成后，使用 GetOfficeConversionTask 接口查询返回的 TaskId，可以查看任务执行结果。任务执行信息只保存 7 天，请及时获取任务执行信息，您也可以使用通知机制，传入 NotifyTopicName 和 NotifyEndpoint，及时通知任务执行信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| imm:CreateOfficeConversionTask | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Project | string | 是 | 项目名称。 | immdoctest |
| SrcUri | string | 是 | 源数据的存储位置。 OSS 地址规则为 | oss://bucket1/object |
| TgtType | string | 否 | 转换输出的目标文件类型。包括如下选项：
| vector |
| TgtUri | string | 是 | 转换后输出内容的目标位置，建议 TgtUri 和 SrcUri 在同一个 OSS Bucket 中，便于权限管理。 生成的目标文件会持久化保存，推荐设置为 OSS Bucket 下的/imm-format-convert-tgt/${name}路径，便于维护管理。 您可以主动删除转换后的目标文件，如果不主动删除则会长期保留以备使用，但是会占用存储空间。如果希望自动的删除目标文件，您也可以在/imm-format-convert-tgt 前缀下配置 OSS 的生命周期。 | oss://bucket1/imm-format-convert-tgt/session123/ |
| NotifyTopicName | string | 否 | 异步反向通知的 TopicName。 | topic1 |
| NotifyEndpoint | string | 否 | 异步反向通知的 Endpoint，文档转换状态可以通过该 Endpoint 异步通知给调用者。使用此功能需要先开通 MNS 服务，新建 topic 和 queue，并配置订阅关系。 说明
MNS 服务和智能媒体管理必须处于同一地域。
| http://1111111111.mns.cn-hangzhou.aliyuncs.com |
| SrcType | string | 否 | 当 OSS 对象没有后缀名时，可以设置此参数。 源数据的后缀类型。默认根据 OSS 对象的后缀名确定源数据的类型。 | doc |
| StartPage | long | 否 | 文档转换的起始页，默认值为 1。 | 1 |
| EndPage | long | 否 | 文档转换的结束页，默认值为 200。如果需要转换所有页，设置此参数为-1。 | 10 |
| MaxSheetRow | long | 否 | 表格文档转换的最大行数，默认值为 1000。如果需要转换所有行，设置此参数为-1。 | 10 |
| MaxSheetCol | long | 否 | 表格文档转换的最大列数，默认值为 100。如果需要转换所有列，设置此参数为-1。 | 10 |
| MaxSheetCount | long | 否 | 表格文档转换的最大 Sheet 数。如果需要转换所有 Sheet，设置此参数为-1。 | 3 |
| SheetOnePage | boolean | 否 | 当 TgtType 设置为 pdf 时，此参数才生效。 表格文档转换为 pdf 时，是否将 Sheet 的所有内容输出到一页。 | false |
| ModelId | string | 否 | 模型 ID。此参数暂不可用。 | 无 |
| Password | string | 否 | 文档的打开密码。如果需要转换有密码的文档，请设置此参数。 | ******** |
| TgtFilePrefix | string | 否 | 当 TgtType 设置为 jpg、png、pdf 时，此参数才生效。 转换后的文件名称前缀，可以是英文、数字、横划线和下划线，且长度不超过 256 个字符。 通过设置 TgtFilePrefix 和 TgtFileSuffix，可以实现自定义转换后的文件名称。 如果 TgtType 设置为 jpg，TgtFilePrefix 和 TgtFileSuffix 设置不同时，目标文件的名称规则如下：
其中[x]表示多个目标文件，从 1 开始。如果 TgtFilePrefix 为 aa，TgtFileSuffix 为 bb，且转换后的文件有 3 页，则所有的目标文件为 aa[1]bb、aa[2]bb、aa[3]bb。 | aa |
| TgtFileSuffix | string | 否 | 当 TgtType 设置为 jpg、png、pdf 时，此参数才生效。 转换后的文件名称后缀，可以是英文、数字、横划线和下划线，且长度不超过 256 个字符。其中 def 为保留字，表示采用默认的后缀名。 通过设置 TgtFilePrefix 和 TgtFileSuffix，可以实现自定义转换后的文件名称。 如果 TgtType 设置为 jpg，TgtFilePrefix 和 TgtFileSuffix 设置不同时，目标文件的名称规则如下：
其中[x]表示多个目标文件，从 1 开始。如果 TgtFilePrefix 为 aa，TgtFileSuffix 为 bb，且转换后的文件有 3 页，则所有的目标文件为 aa[1]bb、aa[2]bb、aa[3]bb。 | bb |
| TgtFilePages | string | 否 | 当 TgtType 设置为 jpg、png、pdf 时，此参数才生效。 转换后输出指定文件页数，最多指定 100 个页数，如果超过 100 页，请分多次转换进行提交，默认输出所有页。例如当 TgtFilePages 设置为"1, 2, 100"时，只会输出第 1、2、100 页到目标位置。 | 1, 2, 100 |
| FitToPagesTall | boolean | 否 | 当 TgtType 设置为 pdf 时，此参数才生效。 表格文档转换为 pdf 时，将行全部输出到一页，默认值为 false。 | false |
| FitToPagesWide | boolean | 否 | 当 TgtType 设置为 pdf 时，此参数才生效。 表格文件转 pdf 时，将列全部输出在一页，默认值为 false。 | false |
| IdempotentToken | string | 否 | 注意 该参数已下线 当传入幂等标识时，如果两次请求完全一致（包括 IdempotentToken 本身），则会返回相同结果，即返回相同的 TaskId。该功能用于避免多次执行同样的任务，消耗额外计算资源。 说明
当出现 ServiceUnavailable 等 HTTP 状态码为 5xx 的异常时，IdempotentToken 可能失效。此时可能会重复创建该任务。
| d1fdd246-e187-11e8-9f32-f2801f1b9fd1 |
| PdfVector | boolean | 否 | 当 PDF 转换为 VECTOR 时，是否使用向量模式，默认值为 false。包括如下选项：
| false |
| Hidecomments | boolean | 否 | 当 WORD、PPT 转换为 VECTOR、JPG、PNG 时，是否隐藏批注和应用修订，默认值为 false。包括如下选项：
| false |
| DisplayDpi | integer | 否 | 当源数据类型转换为 JPG、PNG 时，此参数才生效。 图片分辨率，默认值为 96，单位为 PPI，取值范围为 96~2048。 | 1024 |
| UserData | string | 否 | 用户自定义数据，在 mns 通知中原样返回。 | {"fileid": "123"} |
MNS 通知 请求参数中如果设置了 NotifyTopicName 和 NotifyEndpoint 支持 MNS 事件通知，则智能媒体管理会为您返回异步通知，例如文档转换的页数，通知的消息格式为：
- 转换成功消息
{
"events": [
{
"eventName": "FormatConvertJob:JobFinished",
"eventSource": "acs:imm",
"eventTime": "2020-11-11T06:51:17.35Z",
"imm": {
"taskId": "formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd169b",
"code": "NoError",
"pageCount": "32",
"percent": "100"
}
}
]
}
- 转换失败消息
{
"events": [
{
"eventName": "FormatConvertJob:JobError",
"eventSource": "acs:imm",
"eventTime": "2020-11-11T06:51:17.35Z",
"imm": {
"taskId": "formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd169b",
"code": "FailedToDownloadSrcFile",
"pageCount": "0",
"percent": "0"
}
}
]
}
返回参数
示例
正常返回示例
JSON格式
{
"Status": "Running",
"TaskId": "formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd169b",
"RequestId": "FF3B7D81-66AE-47E0-BF69-157DCF187514",
"Percent": 0,
"CreateTime": "2020-11-11T06:51:17.5Z",
"TgtLoc": "oss://bucket1/imm-format-convert-tgt/session123/"
}错误码
访问错误中心查看更多错误码。