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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListOfficeConversionTask

操作接口名称,系统规定参数,固定取值为ListOfficeConversionTask。

Project String immdoctest

项目名称。

RegionId String cn-hangzhou

项目所在地域的ID。

Marker String formatconvert-00

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

MaxKeys Integer 5

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

返回数据

名称 类型 示例值 描述
NextMarker String formatconvert-481c92f5-3033-4de3-8656-fcf07100d633

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

RequestId String 6253B819-3B81-4578-956B-7CF7E75E39E2

当次请求的Request ID。

Tasks Array of Tasks

任务信息列表。

CreateTime String 2020-11-13T09:32:53.097000Z

任务的创建时间。

ExternalID String tasktest002

当前版本不支持此参数。

任务的外部标签。

FinishTime String 2020-11-13T09:33:03.520000Z

任务的结束时间。

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

ImageSpec String 1024

当前版本不支持此参数。

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

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

NotifyEndpoint String http://1111111111.mns.cn-hangzhou.aliyuncs.com

异步反向通知的Endpoint。

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

NotifyTopicName String topic1

异步反向通知的TopicName。

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

PageCount Integer 10

文档格式转换的页数。

Percent Integer 100

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

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

SrcUri String oss://bucket1/object

源数据的存储位置。

Status String Finished

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

  • Running:任务运行中。
  • Finished:任务执行完成,转换成功。
  • Failed:任务执行完成,转换成功失败。具体失败原因请参考FaileDetail的Code内容。
TaskId String formatconvert-bab90254-2bfd-4ee5-a30a-bb671da7c960

任务ID。

TgtType String png

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

TgtUri String oss://bucket1/converttasks/session123/

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

示例

请求示例

http(s)://[Endpoint]/?Action=ListOfficeConversionTask
&Project=immdoctest
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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