首页 智能媒体管理 旧版API参考（2017-09-06） API目录 文档管理 文档转换同步请求 ConvertOfficeFormat - 文档（例如OFFICE文档）格式的转换

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

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

接口说明

注意事项

同步转换超时时间为5秒，如果转换时间大于5秒的文档转换需要使用异步接口CreateOfficeConversionTask。

调试

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

调试

授权信息

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

请求参数

名称类型必填描述示例值
Projectstring是

项目名称。

说明您可通过智能媒体管理的控制台或调用ListProjects接口查看项目名称。关于项目名称的更多信息，请参见创建项目。
immdoctest
SrcUristring是

源数据的存储位置。

OSS地址规则为oss://bucket/object，其中bucket为和当前项目处于同一地域的OSS Bucket名称，object为包含文件扩展名的文件完整路径。

oss://bucket1/object
TgtTypestring否

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

  • vector：转换为向量格式的文件，需要使用预览引擎进行渲染后才能预览。

  • png：转换为PNG格式的图片文件。

  • jpg：转换为JPG格式的图片文件。

  • pdf：转换为PDF文件。

  • text：转换为只包含文本内容的文件，主要用于提取文件的文本内容。

说明只有当源数据类型为演示文档和文字文档时，才支持转换为text格式。
vector
TgtUristring是

转换后输出内容的目标位置，建议将TgtUri和SrcUri设置在同一个OSS Bucket中，便于权限管理。

oss://bucket1/converttasks/session123/
SrcTypestring否

当OSS对象没有后缀名时，可以设置此参数。

源数据的后缀类型。默认根据OSS对象的后缀名确定源数据的类型。

doc
StartPagelong否

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

1
EndPagelong否

文档转换的结束页，默认值为200。如果需要转换所有页，设置此参数为-1。

10
MaxSheetRowlong否

表格文档转换的最大行数，默认值为1000。如果需要转换所有行，设置此参数为-1。

10
MaxSheetCollong否

表格文档转换的最大列数，默认值为100。如果需要转换所有列，设置此参数为-1。

10
MaxSheetCountlong否

表格文档转换的最大Sheet数。如果需要转换所有Sheet，设置此参数为-1。

3
SheetOnePageboolean否

表格文档转换时，是否将所有Sheet的内容输出到一页。

false
ModelIdstring否

模型ID。此参数暂不可用。

无
Passwordstring否

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

********
TgtFilePrefixstring否
说明当参数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
TgtFileSuffixstring否
说明当参数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
TgtFilePagesstring否
说明当参数TgtType设置为jpg、png或pdf时，此参数才生效。

转换后输出指定文件页数，默认输出所有页。最多指定100个页数，如果超过100页，请分多次转换进行提交。

例如当TgtFilePages设置为[1, 2, 100]时，只会输出第1、2、100页到目标位置。

[1, 2, 100]
FitToPagesTallboolean否
说明当参数TgtType设置为pdf时，此参数才生效。

表格文档转换为PDF文档时，是否将行全部输出到一页。取值范围如下：

  • false（默认）：否。

  • true：是。

false
FitToPagesWideboolean否
说明当参数TgtType设置为pdf时，此参数才生效。

表格文档转换为PDF文档时，是否将列全部输出在一页。取值范围如下：

  • false（默认）：否。

  • true：是。

false
PdfVectorboolean否

当PDF转换为VECTOR时，是否使用向量模式，取值范围如下：

  • true：使用向量模式，预览效果比较清晰，但是转换耗时较长。
  • false（默认）：使用图片模式，预览效果一般，但是转换耗时较短。
false
Hidecommentsboolean否

当WORD、PPT转换为VECTOR、JPG、PNG时，是否隐藏批注和应用修订。取值范围如下：

  • true：隐藏批注和应用修订。
  • false（默认）：显示批注和修订。
false

返回参数

名称类型描述示例值
object
PageCountinteger

转换成功的页数。

10
RequestIdstring

当次请求的Request ID。

FF3B7D81-66AE-47E0-BF69-157DCF187514

示例

正常返回示例

JSON格式

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

错误码

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

错误码

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

相关文档
阿里云首页 智能媒体管理 相关技术圈