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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
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	转换文件失败，请使用钉钉搜索钉钉群号21714099加入钉钉群进行反馈。
InternalError	内部错误，请使用钉钉搜索钉钉群号21714099加入钉钉群进行反馈。