调用GetOfficeConversionTask查询异步文档格式转换任务的状态信息

调用GetOfficeConversionTask接口查询异步文档格式转换任务的状态信息。

接口说明

此接口已不再维护，建议使用新版（2020-09-30 版本）接口 GetTask 。关于新版与旧版 API 的对比，请参见新旧版本使用指引中的新版与旧版 API 对应关系说明章节。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
imm:GetOfficeConversionTask		全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Project	string	是	项目名称。	immdoctest
TaskId	string	是	任务 ID。CreateOfficeConversionTask 接口执行后返回的 TaskId。异步文档格式转换任务的 TaskId 可以通过智能媒体管理控制台对应项目的任务查询页签获取。	formatconvert-a1749f07-1bb7-40ff-84af-c6df064e****

返回参数

名称	类型	描述	示例值
	object
Status	string	任务运行状态。包括如下选项： Running：任务运行中。 Finished：任务执行完成，转换成功。 Failed：任务执行完成，转换失败。具体失败原因请参考 FaileDetail 的 Code 内容。	Finished
FailDetail	object	任务执行对应的错误信息。
Code	string	错误码。	NoError
TgtType	string	转换输出的目标文件类型。	png
TaskId	string	任务 ID，和请求时一致。	formatconvert-a1749f07-1bb7-40ff-84af-c6df064e****
RequestId	string	当次请求的 Request ID。	0BC1F0C9-8E99-46C6-B502-10DEDCBA3E2E
Percent	integer	任务进度的百分比。当前只有 0 和 100 两个结果。只有当转换成功时，此参数的返回值才为 100，其他情况均为 0。	100
CreateTime	string	任务的创建时间。	2020-11-13T07:53:08.687000Z
ExternalID	string	当前版本不支持此参数。任务的外部标签。	tasktest001
ImageSpec	string	当前版本不支持此参数。输出图片的边界大小，默认值为 1024 像素。当图片长宽不同时，按照最先到达边界的条件进行等比例控制。	1024
NotifyEndpoint	string	异步反向通知的 Endpoint。如果创建任务时未设置此参数，则返回值为空。	http://1111111111.mns.cn-hangzhou.aliyuncs.com
TgtUri	string	转换后输出内容的目标位置。	oss://bucket1/converttasks/session123/
FinishTime	string	任务的结束时间。当任务状态为 Finished 时，此参数才有值，否则返回值为空。	2020-11-13T07:53:19.103000Z
PageCount	integer	文档格式转换的页数。	10
NotifyTopicName	string	异步反向通知的 TopicName。如果创建任务时未设置此参数，则返回值为空。	topic1
SrcUri	string	源数据的存储位置。	oss://bucket1/object

示例

正常返回示例

JSON格式

{
  "Status": "Finished",
  "FailDetail": {
    "Code": "NoError"
  },
  "TgtType": "png",
  "TaskId": "formatconvert-a1749f07-1bb7-40ff-84af-c6df064e****",
  "RequestId": "0BC1F0C9-8E99-46C6-B502-10DEDCBA3E2E",
  "Percent": 100,
  "CreateTime": "2020-11-13T07:53:08.687000Z",
  "ExternalID": "tasktest001",
  "ImageSpec": "1024",
  "NotifyEndpoint": "http://1111111111.mns.cn-hangzhou.aliyuncs.com",
  "TgtUri": "oss://bucket1/converttasks/session123/",
  "FinishTime": "2020-11-13T07:53:19.103000Z",
  "PageCount": 10,
  "NotifyTopicName": "topic1",
  "SrcUri": "oss://bucket1/object"
}

错误码

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

错误码

错误码	描述
NoError	无错误，文档转换成功。
FailedToDownloadSrcFile	无法下载源文件，请检查 OSS Bucket 是否存在和 OSS Bucket 中的对象是否存在。
UnsupportedSrcFile	不支持的文件类型，目前文档转换根据文件后缀名判断文件类型，请检查文件后缀名。
ConvertTimeout	文档转换超时，目前文档转换超时时间为 300 秒。当文件页数较多或者表格行列多的文档可能会出现该错误，此时可以调整 EndPage、MaxSheetRow、MaxSheetCol、MaxSheetCount 参数转换部分文档。
WriteTgtUriFailed	转换后的文件写入 OSS 失败。当 OSS 服务不稳定时可能出现该错误，此时建议重新提交文档转换任务。
InvokeOSSFailed	转换后的文件写入 OSS 失败，请检查 TgtUri 对应的 OSS Bucket 是否存在。
OpenFileError	转换时，文件打开失败，请检查源文档后缀和内容是否匹配。
ExportFileError	转换时，文件内容处理失败，请检查源文档是否能够正常打开。
ExceedFileSizeLimit	文档转换默认支持的文件大小为 200 MB，超过该大小的文件转换时会出现该错误。
NeedPassword	打开文件需要密码，请设置 Password 参数。
ConvertFailed	转换文件失败，请使用钉钉搜索钉钉群号 31690030817 加入钉钉群进行反馈。
InternalError	内部错误，请使用钉钉搜索钉钉群号 31690030817 加入钉钉群进行反馈。