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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
RegionId String 否 cn-hangzhou

项目所在地域的ID。

地域Endpoint格式为imm.RegionId.aliyuncs.com，例如当RegionId为cn-hangzhou时，地域Endpoint为imm.cn-hangzhou.aliyuncs.com。

Action String 是 GetOfficeConversionTask

操作接口名称，固定取值为GetOfficeConversionTask。
Project String 是 immdoctest

项目名称。
TaskId String 是 formatconvert-a1749f07-1bb7-40ff-84af-c6df064e****

任务ID。CreateOfficeConversionTask接口执行后返回的TaskId。

异步文档格式转换任务的TaskId可以通过智能媒体管理控制台对应项目的任务查询页签获取。

返回数据

名称 类型 示例值 描述
Status String Finished

任务运行状态。包括如下选项：

  • Running：任务运行中。
  • Finished：任务执行完成，转换成功。
  • Failed：任务执行完成，转换失败。具体失败原因请参考FaileDetail的Code内容。
FailDetail Object

任务执行对应的错误信息。
Code String NoError

错误码。
TgtType String png

转换输出的目标文件类型。
TaskId String formatconvert-a1749f07-1bb7-40ff-84af-c6df064e****

任务ID，和请求时一致。
RequestId String 0BC1F0C9-8E99-46C6-B502-10DEDCBA3E2E

当次请求的Request ID。
Percent Integer 100

任务进度的百分比。当前只有0和100两个结果。

只有当转换成功时，此参数的返回值才为100，其他情况均为0。
CreateTime String 2020-11-13T07:53:08.687000Z

任务的创建时间。
ExternalID String tasktest001

当前版本不支持此参数。

任务的外部标签。
ImageSpec String 1024

当前版本不支持此参数。

输出图片的边界大小，默认值为1024像素。

当图片长宽不同时，按照最先到达边界的条件进行等比例控制。
NotifyEndpoint String http://1111111111.mns.cn-hangzhou.aliyuncs.com

异步反向通知的Endpoint。

如果创建任务时未设置此参数，则返回值为空。
TgtUri String oss://bucket1/converttasks/session123/

转换后输出内容的目标位置。
FinishTime String 2020-11-13T07:53:19.103000Z

任务的结束时间。

当任务状态为Finished时，此参数才有值，否则返回值为空。
PageCount Integer 10

文档格式转换的页数。
NotifyTopicName String topic1

异步反向通知的TopicName。

如果创建任务时未设置此参数，则返回值为空。
SrcUri String oss://bucket1/object

源数据的存储位置。

示例

请求示例

http(s)://[Endpoint]/?Action=GetOfficeConversionTask
&Project=immdoctest
&TaskId=formatconvert-a1749f07-1bb7-40ff-84af-c6df064e****
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Status" : "Finished",
  "FailDetail" : {
    "Code" : "NoError"
  },
  "TgtType" : "png",
  "TaskId" : "formatconvert-a1749f07-1bb7-40ff-84af-c6df064e3438",
  "RequestId" : "0BC1F0C9-8E99-46C6-B502-10DEDCBA3E2E",
  "Percent" : 100,
  "CreateTime" : "2020-11-13T07:53:08.687000Z",
  "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

转换文件失败，请提交工单并提供RequestId。

InternalError

内部错误，请提交工单并提供RequestId。