查询转换任务进度

更新时间不可用

查询七天内创建的文档转换任务的进度。

GET
https://api.netless.link/v5/projector/tasks/{uuid}

注意

调用文档转换 API 前,请确保:

路径参数

uuidstring
必填

转换任务的 UUID,即转换任务的唯一标识符,可通过调用发起文档转换 API 获取。

请求 Header

tokenstring
必填

Task Token,可通过以下方式获取:

regionstring
必填

指定处理该请求的数据中心,取值如下:

  • cn-hz:中国杭州,服务区覆盖中国大陆地区及其他数据中心未覆盖的区域。

  • us-sv:美国硅谷,服务区覆盖北美洲、南美洲。

  • sg:新加坡,服务区覆盖新加坡、东亚、东南亚。

  • in-mum:印度孟买,服务区覆盖印度。

  • eu:欧洲(法兰克福),服务区覆盖欧洲。

响应

若返回的状态码为 200 则表示请求成功。响应 Body 中包含本次请求的结果。

若返回的状态码不为 200 则表示请求失败。你可以参考响应状态码了解可能的原因。

响应 Body

字段
uuidstring

转换任务的 UUID,即转换任务的唯一标识符。

statusstring

转换任务的状态:

  • Waiting:等待转换。

  • Converting:转换中。

  • Finished:已完成。

  • Fail:失败。

typestring

转换任务类型,取值如下:

  • dynamic:动态文档转换,即文档转网页。

  • static:静态文档转换,即文档转图片。

convertedPercentagenumber

转换进度百分比。

prefixstring

转换结果文件地址前缀路径。

pageCountnumber

文档页数,转换任务失败时没有该字段。

转换后的文档预览图地址,每页对应一个预览图地址。该参数仅在发起文档转换时,请求 Body 中的 preview 设为 true ,且 type 设为 dynamic 时才生效。

notestring

从文档中提取出的备注内容,只包含有备注的页面。

文档转图片结果的地址,每页对应一张图片。该参数仅在该参数仅在发起文档转换时,请求 Body 中的 type 设为 static 时才生效。

errorCodestring

错误码。仅在转换任务失败时,才会返回该字段。所有可能的错误码详见文档转换错误码。

errorMessagestring

错误码对应的错误消息,描述出错的原因。仅在转换任务失败时,才会返回该字段。

zipstring

该链接可下载一个包含 ppt 的转换结果全部集合的压缩包,其中包括 PPT 预览图和渲染需要的所有资源,可配合 SDK 提供的 API 重定向到本地资源,实现全部预加载,而不是每次加载 PPT 资源时向服务器请求,从而减少用户查看 PPT 和切页时的等待时间。

resourcesarray<string>

所有渲染所需资源的下载链接列表,可用于私有云存储做批量链接签名,以便安全地分享或访问这些资源。

请求示例

Example Request
curl --request GET \
  --url "https://api.netless.link/v5/projector/tasks/:uuid" \
  --header 'token: <string>' \
  --header 'region: cn-hz'

响应示例

{
  "uuid": "dc11fe9e1xxxxxx7cd7ca3670a",
  "type": "dynamic",
  "status": "Finished",
  "convertedPercentage": 100,
  "pageCount": 2,
  "previews": {
    "1": "https://xxx/flat/dynamicConvert/xxx/1.png",
    "2": "https://xxx/flat/dynamicConvertxxx/2.png"
  },
  "note": "https://xxx/jsonOutput/note.json",
  "prefix": "https://xxx/flat/dynamicConvert",
  "zip": "https://xxx.com/flat/dynamicConvert/xxx.zip",
  "resources": [
    "https://xxx/jsonOutput/note.json",
    "https://xxx/flat/dynamicConvert/xxx/1.png",
    "https://xxx/flat/dynamicConvert/xxx/2.png"
  ]
}