首页 >智能媒体管理 >API参考 >API目录 >文档管理 >文档转换异步请求 >ListOfficeConversionTask - 列出项目中已创建的文档格式转换任务

ListOfficeConversionTask - 列出项目中已创建的文档格式转换任务

调用ListOfficeConversionTask接口列出项目中已创建的文档格式转换任务。

调试

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

调试

授权信息

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

请求参数

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

项目名称。

immdoctest
Markerstring

从Marker开始按字典序返回任务信息列表。如果不设置此参数,则从头开始返回任务。

formatconvert-00
MaxKeysinteger

返回任务的最大个数,默认值为100,取值范围为1~100。

5

返回参数

名称类型描述示例值
object
NextMarkerstring

下一次列出任务信息时以此值为Marker,将未返回的结果返回。 当任务未全部返回时,此参数才有值。

formatconvert-481c92f5-3033-4de3-8656-fcf07100d633
RequestIdstring

当次请求的Request ID。

6253B819-3B81-4578-956B-7CF7E75E39E2
Tasksarray

任务信息列表。

object
Statusstring

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

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

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

只有当转换成功时,此参数的返回值才为100,其他情况均为0。

100
FinishTimestring

任务的结束时间。

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

2020-11-13T09:33:03.520000Z
CreateTimestring

任务的创建时间。

2020-11-13T09:32:53.097000Z
PageCountinteger

文档格式转换的页数。

10
NotifyTopicNamestring

异步反向通知的TopicName。

如果创建任务时未设置此参数,则返回值为空。

topic1
NotifyEndpointstring

异步反向通知的Endpoint。

如果创建任务时未设置此参数,则返回值为空。

http://1111111111.mns.cn-hangzhou.aliyuncs.com
SrcUristring

源数据的存储位置。

oss://bucket1/object
TgtTypestring

转换输出的目标文件类型。

png
TgtUristring

转换后输出内容的目标位置。

oss://bucket1/converttasks/session123/
ImageSpecstring

当前版本不支持此参数。

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

当图片长宽不同时,按照最先到达边界的条件进行等比例控制。

1024
ExternalIDstring

当前版本不支持此参数。

任务的外部标签。

tasktest002
TaskIdstring

任务ID。

formatconvert-bab90254-2bfd-4ee5-a30a-bb671da7c960

示例

正常返回示例

JSON格式

{
  "NextMarker": "formatconvert-481c92f5-3033-4de3-8656-fcf07100d633",
  "RequestId": "6253B819-3B81-4578-956B-7CF7E75E39E2",
  "Tasks": [
    {
      "Status": "Finished",
      "Percent": 100,
      "FinishTime": "2020-11-13T09:33:03.520000Z",
      "CreateTime": "2020-11-13T09:32:53.097000Z",
      "PageCount": 10,
      "NotifyTopicName": "topic1",
      "NotifyEndpoint": "http://1111111111.mns.cn-hangzhou.aliyuncs.com",
      "SrcUri": "oss://bucket1/object",
      "TgtType": "png",
      "TgtUri": "oss://bucket1/converttasks/session123/",
      "ImageSpec": "1024",
      "ExternalID": "tasktest002",
      "TaskId": "formatconvert-bab90254-2bfd-4ee5-a30a-bb671da7c960"
    }
  ]
}

错误码

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

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