查询转换任务的进度

更新时间不可用

查询文档转换任务的进度。

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

路径参数

uuidstring
必填

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

请求 Header

tokenstring
必填

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

regionstring
必填

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

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

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

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

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

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

响应

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

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

响应 Body

字段
uuidstring

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

typestring

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

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

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

statusstring

转换任务的状态:

  • Waiting:等待转换。

  • Converting:转换中。

  • Finished:已完成。

  • Fail:失败。

failedReasonstring

转换任务失败的原因。只有当 status 为 Fail 时,才会返回该字段。

转换任务的进度。

请求示例

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

响应示例

{
  "uuid": "2fdxxxx7e",
  "type": "static",
  "status": "Finished",
  "progress": {
    "totalPageSize": 2,
    "convertedPageSize": 2,
    "convertedPercentage": 100,
    "convertedFileList": [
      {
        "width": 1333,
        "height": 750,
        "conversionFileUrl": "https://docs-test-xxx.oss-cn-hangzhou.aliyuncs.com/staticConvert/2fdxxxxx67e/1.jpeg"
      },
      {
        "width": 1333,
        "height": 750,
        "conversionFileUrl": "https://docs-test-xxx.oss-cn-hangzhou.aliyuncs.com/staticConvert/2fdxxxxx67e/2.jpeg"
      }
    ]
  }
}