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

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

接口说明

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

调试

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

授权信息

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

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

请求参数

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

项目名称。

immdoctest
Markerstring

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

formatconvert-00
MaxKeysinteger

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

5

返回参数

名称类型描述示例值
object
Tasksarray<object>

任务信息列表。

Tasksobject
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
TgtUristring

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

oss://bucket1/converttasks/session123/
TgtTypestring

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

png
SrcUristring

源数据的存储位置。

oss://bucket1/object
ImageSpecstring

当前版本不支持此参数。

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

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

1024
ExternalIDstring

当前版本不支持此参数。

任务的外部标签。

tasktest002
TaskIdstring

任务 ID。

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

当次请求的 Request ID。

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

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

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

示例

正常返回示例

JSON格式

{
  "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",
      "TgtUri": "oss://bucket1/converttasks/session123/",
      "TgtType": "png",
      "SrcUri": "oss://bucket1/object",
      "ImageSpec": "1024",
      "ExternalID": "tasktest002",
      "TaskId": "formatconvert-bab90254-2bfd-4ee5-a30a-bb671da7c960"
    }
  ],
  "RequestId": "6253B819-3B81-4578-956B-7CF7E75E39E2",
  "NextMarker": "formatconvert-481c92f5-3033-4de3-8656-fcf07100d633"
}

错误码

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