采用同步请求方式进行文档（例如Office文档）格式的转换，执行完毕返回转换成功的页数。

接口说明

此接口已不再维护，建议使用新版（2020-09-30 版本）接口 CreateOfficeConversionTask 。关于新版与旧版 API 的对比，请参见新旧版本使用指引中的新版与旧版 API 对应关系说明章节。
同步转换超时时间为 5 秒，如果转换时间大于 5 秒的文档转换需要使用异步接口 CreateOfficeConversionTask 。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Project	string	是	项目名称。说明您可通过智能媒体管理的控制台或调用 ListProjects 接口查看项目名称。关于项目名称的更多信息，请参见创建项目。	immdoctest
SrcUri	string	是	源数据的存储位置。 OSS 地址规则为`oss://bucket/object`，其中`bucket`为和当前项目处于同一地域的 OSS Bucket 名称，`object`为包含文件扩展名的文件完整路径。	oss://bucket1/object
TgtType	string	否	转换输出的目标文件类型。包括如下选项： vector：转换为向量格式的文件，需要使用预览引擎进行渲染后才能预览。 png：转换为 PNG 格式的图片文件。 jpg：转换为 JPG 格式的图片文件。 pdf：转换为 PDF 文件。 text：转换为只包含文本内容的文件，主要用于提取文件的文本内容。说明只有当源数据类型为演示文档和文字文档时，才支持转换为 text 格式。	vector
TgtUri	string	是	转换后输出内容的目标位置，建议将 TgtUri 和 SrcUri 设置在同一个 OSS Bucket 中，便于权限管理。	oss://bucket1/converttasks/session123/
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	否	表格文档转换时，是否将所有 Sheet 的内容输出到一页。	false
ModelId	string	否	模型 ID。此参数暂不可用。	无
Password	string	否	文档的打开密码。如果需要转换有密码的文档，请设置此参数。	********
TgtFilePrefix	string	否	说明当参数 TgtType 设置为`jpg`、`png`或`pdf`时，此参数才生效。转换后的文件名称前缀。通过设置该参数，可以自定义转换后的文件名称。命名规则如下：只能包括英文、数字、短划线（-）和下划线（_）。长度不超过 256 个字符。当参数 TgtType 设置为 jpg，参数 TgtFilePrefix 和参数 TgtFileSuffix 设置不同时，目标文件的名称规则如下：当 TgtFilePrefix 和 TgtFileSuffix 均为空时，则目标文件的名称为`\[x\].jpg`。当 TgtFilePrefix 为空，TgtFileSuffix 为`aa`时，则目标文件的名称为`\[x\]aa`。当 TgtFilePrefix 为`aa`，TgtFileSuffix 为空时，则目标文件的名称为aa[x]。当 TgtFilePrefix 为`aa`，TgtFileSuffix 为`bb`时，则目标文件名称为`aa\[x\]bb`。当 TgtFilePrefix 为`aa`，TgtFileSuffix 为`def`时，则目标文件名称为`aa\[x\].jpg`。其中`def`为保留字，表示采用默认的后缀名。其中`\[x\]`表示多个目标文件，从`1`开始。如果 TgtFilePrefix 为`aa`，TgtFileSuffix 为`bb`，且转换后的文件有 3 页，则所有的目标文件为`aa\[1\]bb`、`aa\[2\]bb`、`aa\[3\]bb`。	aa
TgtFileSuffix	string	否	说明当参数 TgtType 设置为`jpg`、`png`或`pdf`时，此参数才生效。转换后的文件名称后缀。通过设置该参数，可以自定义转换后的文件名称。命名规则如下：只能包括英文、数字、短划线（-）和下划线（_）。长度不超过 256 个字符。当参数 TgtType 设置为`jpg`，参数 TgtFilePrefix 和参数 TgtFileSuffix 设置不同时，目标文件的名称规则如下：当 TgtFilePrefix 和 TgtFileSuffix 均为空时，则目标文件的名称为`\[x\].jpg`。当 TgtFilePrefix 为空，TgtFileSuffix 为`aa`时，则目标文件的名称为`\[x\]aa`。当 TgtFilePrefix 为`aa`，TgtFileSuffix 为空时，则目标文件的名称为`aa\[x\]`。当 TgtFilePrefix 为`aa`，TgtFileSuffix 为`bb`时，则目标文件名称为`aa\[x\]bb`。当 TgtFilePrefix 为`aa`，TgtFileSuffix 为`def`时，则目标文件名称为`aa\[x\].jpg`。其中`def`为保留字，表示采用默认的后缀名。上述规则中`\[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（默认）：否。 true：是。	false
FitToPagesWide	boolean	否	说明当参数 TgtType 设置为`pdf`时，此参数才生效。表格文档转换为 PDF 文档时，是否将列全部输出在一页。取值范围如下： false（默认）：否。 true：是。	false
PdfVector	boolean	否	当 PDF 转换为 VECTOR 时，是否使用向量模式，取值范围如下： true：使用向量模式，预览效果比较清晰，但是转换耗时较长。 false（默认）：使用图片模式，预览效果一般，但是转换耗时较短。	false
Hidecomments	boolean	否	当 WORD、PPT 转换为 VECTOR、JPG、PNG 时，是否隐藏批注和应用修订。取值范围如下： true：隐藏批注和应用修订。 false（默认）：显示批注和修订。	false

返回参数

名称	类型	描述	示例值
	object
PageCount	integer	转换成功的页数。	10
RequestId	string	当次请求的 Request ID。	FF3B7D81-66AE-47E0-BF69-157DCF187514

示例

正常返回示例

JSON格式

{
  "PageCount": 10,
  "RequestId": "FF3B7D81-66AE-47E0-BF69-157DCF187514"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidArgument.SrcUri	The source URI is too large or too complex to be converted within the time limit.	源文件太多或者太复杂，无法在给定时间内完成转换

访问错误中心查看更多错误码。

错误码

如果转换出错，返回的 JSON 示例如下：

{
    "RequestId": "7DA1FCD1-004C-4EB4-B039-C6BBDCEB0701",
    "HostId": "imm.cn-hangzhou.aliyuncs.com",
    "Code": "DocumentConvertFailed.NeedPassword",
    "Message": "The conversion has been failed, need password to open file."
}

错误码	说明
OSSAccessError	OSS 访问失败，请检查 SrcUri 或 TgtUri 对应 OSS Bucket 的路径是否存在，所在 Region 是否和智能媒体管理的 Region 一致。
InvalidParameter.SrcType.NotSupported	不支持的文件类型，文档转换根据文件后缀名来判断文件类型，请检查文件后缀名和 SrcType 参数。
DocumentConvertFailed.ExceedFileSizeLimit	文档转换默认支持的文件大小为 200 MB，超过该大小的文件转换时会出现该错误。
DocumentConvertFailed.OpenFileError	文档转换时，打开文件失败，请检查源文档后缀和内容是否匹配。
DocumentConvertFailed.ExportFileError	文档转换时，处理文件内容失败，请检查源文档是否能够正常打开。
DocumentConvertFailed.NeedPassword	该文档需要密码才能打开，请设置 Password 参数。
ExecutionTimeout	执行超时，请检查文档大小和页数，如果确实需要转换，请使用异步接口 CreateOfficeConversionTask 。
InternalError	内部错误，请使用钉钉搜索钉钉群号 31690030817 加入钉钉群进行反馈。

ConvertOfficeFormat - 文档（例如OFFICE文档）格式的转换

接口说明

调试

授权信息

请求参数

返回参数

示例

错误码

错误码

相关文档