GetOfficeConversionTask_文档转换异步请求_文档管理操作_API手册

描述

查询文件格式转换任务状态。

请求参数

名称	类型	是否必填	描述
Project	String	是	项目名
Action	String	是	GetOfficeConversionTask
TaskId	String	是	任务 ID

返回参数

名称	类型	描述
RequestId	String	用户发送的每次接口调用请求，无论成功与否，系统都会返回一个唯一识别码 RequestId 给用户
TaskId	String	任务 ID
Status	String	任务执行状态 Running：表示文档转换任务正在执行中 Failed：表示文档转换任务执行完成，但是转换失败，具体失败原因请参考FaileDetail.Cdoe Finished：表示文档转换任务执行完成，转换成功
FailDetail	Object	任务执行结果对应的Json对象
Code	String	任务执行结果，参考错误代码
Percent	Integer	任务进度百分比，0-100 的整数，当前并不支持细粒度的百分比，只有0，100两个结果
PageCount	Integer	页数
SrcUri	String	源数据的存储位置，例如 OSS 资源”oss://bucket1/object”
TgtType	String	转换输出目标文件类型
TgtUri	String	转换输出内容到目标位置，例如 OSS 桶的指定前缀”oss://bucket1/converttasks/session123/“
NotifyTopicName	String	异步反向通知的 TopicName，不存在则为空
NotifyEndpoint	String	异步反向通知的 Endpoint，不存在则为空
CreateTime	String	任务创建时间，例如”2018-07-20T06:51:17.5Z”
FinishTime	String	任务结束时间，当任务状态为 “Finished” 时，才是真实的值。否则，内容为空。

示例

请求示例

POST https://imm.cn-shanghai.aliyuncs.com
?Action=GetOfficeConversionTask
&Project=test
&TaskId=23468948-33EA-28A0-CA35-452ACE867326
...

此处的示例，目的是展示关键参数，还需要其他的公共参数才能正常调用，推荐使用 SDK 来发送 API。

返回示例

任务运行时返回的结果

{
  "FailDetail": {
    "Code": ""
  },
  "NotifyTopicName": "imm-go-mns-sdk-test",
  "TaskId": "bf192382-6e4e-4f7f-a0bb-af44966e8401",
  "NotifyEndpoint": "http://11111111.mns.cn-shanghai.aliyuncs.com/",
  "PageCount": 0,
  "Status": "Running",
  "TgtType": "vector",
  "FinishTime": "",
  "RequestId": "3BD5362D-338B-4004-A524-10F99A0CFF0E",
  "CreateTime": "2018-09-21T07:08:50.321Z",
  "SrcUri": "oss://xxxxxx/xxxx.docx",
  "Percent": 0,
  "TgtUri": "oss://xxxxxxx"
}

任务失败时返回的结果

{
  "FailDetail": {
    "Code": "FailedToDownloadSrcFile"
  },
  "NotifyTopicName": "imm-go-mns-sdk-test",
  "TaskId": "bf192382-6e4e-4f7f-a0bb-af44966e8401",
  "NotifyEndpoint": "http://11111111.mns.cn-shanghai.aliyuncs.com/",
  "PageCount": 0,
  "Status": "Failed",
  "TgtType": "vector",
  "FinishTime": "",
  "RequestId": "3BD5362D-338B-4004-A524-10F99A0CFF0E",
  "CreateTime": "2018-09-21T07:08:50.321Z",
  "SrcUri": "oss://xxxxxx/xxxx.docx",
  "Percent": 0,
  "TgtUri": "oss://xxxxxxx"
}

任务成功时返回的结果

{
  "FailDetail": {
    "Code": "NoError"
  },
  "NotifyTopicName": "imm-go-mns-sdk-test",
  "TaskId": "6125760b-9716-4b80-ac15-795915a09793",
  "NotifyEndpoint": "http://1111111111111.mns.cn-shanghai.aliyuncs.com/",
  "PageCount": 8,
  "Status": "Finished",
  "TgtType": "vector",
  "FinishTime": "2018-09-21T07:22:18.29Z",
  "RequestId": "0CE7E99B-5922-4DA2-84B7-7C4756E42E96",
  "CreateTime": "2018-09-21T07:22:16.271Z",
  "SrcUri": "oss://xxxxxx/xxxxxx.docx",
  "Percent": 100,
  "TgtUri": "oss://xxxxxxx"
}

错误代码

错误代码	说明
NoError	没有错误，文档转换正常完成
FailedToDownloadSrcFile	无法下载源文件，请检查 OSS Bucket 是否存在，oss对象是否存在
UnsupportedSrcFile	不支持的文件类型，当前文档转换根据文件后缀名来判断文件类型，请检查文件后缀名
ConvertTimeout	文档转换超时，当前文档转换超时时间为 300 秒，多发生在文件页数较多或者表格行列多的文档，可以调整 EndPage，MaxSheetRow，MaxSheetCol，MaxSheetCount 参数来转换部分文档
WriteTgtUriFailed	将转换后的文件写到 OSS 失败，多发生在 OSS 服务不稳定情况下，建议重新提交文档转换任务
InvokeOSSFailed	将转换后的文件写到 OSS 失败，请检查 TgtUri 对应多OSS Bucket 是否存在
OpenFileError	转换时，打开文件失败，请检查源文档后缀和内容是否匹配
ExportFileError	转换时，处理文件内容失败，请检查源文档是否能够正常打开
ExceedFileSizeLimit	当前文档转换默认支持 40 MB 文件大小，超过该大小的文件转换时会抛出该错误
NeedPassword	该文件需要密码打开，请设置 Password 参数
ConvertFailed	转换文件失败，请开工单并提供 RequestId
InternalError	内部错误，请开工单并提供 RequestId

若在使用中有疑问，请参考 FAQ，或者进入钉钉用户群实时交流。