查询转码任务进度

更新时间不可用

查询七天内创建的 PPT 转码任务的进度。

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

路径参数

uuidstring
必填

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

请求 Header

tokenstring
必填

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

regionstring
必填

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

  • cn-hz:中国杭州,服务区覆盖中国大陆地区及其他数据中心未覆盖的区域。
  • us-sv:美国硅谷,服务区覆盖北美洲、南美洲。
  • sg:新加坡,服务区覆盖新加坡、东亚、东南亚。
  • in-mum:印度孟买,服务区覆盖印度。
  • eu:欧洲(法兰克福),服务区覆盖欧洲。

响应

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

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

响应 Body

字段
uuidstring

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

statusstring

转换任务的状态:

  • Waiting:等待转换。
  • Converting:转换中。
  • Finished:已完成。
  • Fail:失败。
typestring

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

  • dynamic:动态文档转换,即文档转网页。
  • static:静态文档转换,即文档转图片。
convertedPercentagenumber

转换进度百分比。

prefixstring

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

pageCountnumber

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

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

notestring

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

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

errorCodestring

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

errorMessagestring

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

请求示例

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

响应示例

{
  "uuid": "2fdxxxx7e",
  "status": "Finished",
  "type": "dynamic",
  "convertedPercentage": 100,
  "prefix": "https://xxxx.com/dynamicConvert",
  "pageCount": 10,
  "previews": {
    "1": "https://xxxx.xx.xx/1.png",
    "2": "https://xxxx.xx.xx/2.png"
  },
  "note": "https://xxx.xx.xx/note.json",
  "images": {
    "1": {
      "width": 720,
      "height": 1080,
      "url": "https://xxxx.xx.xx/1.xxx"
    },
    "2": {
      "width": 720,
      "height": 1080,
      "url": "https://xxxx.xx.xx/2.xxx"
    }
  },
  "errorCode": "20xxxxx",
  "errorMessage": "xxx"
}