查询转换任务的进度
更新时间不可用
查询文档转换任务的进度。
https://api.netless.link/v5/services/conversion/tasks/{uuid}uuidstring转换任务的 UUID,即转换任务的唯一标识符,可通过调用发起文档转换 API 获取。
tokenstringSDK Token,可以通过以下方式获取:
-
在声网控制台生成用于测试的 SDK Token,详见获取互动白板项目的安全密钥。
-
调用服务端 RESTful API, 详见生成 SDK Token。
-
在 App 服务端用代码生成,详见在 App 服务端生成 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 时,才会返回该字段。
转换任务的进度。
totalPageSizenumber转换文档总页数。
convertedPageSizenumber已经完成转换的页数。
convertedPercentagenumber转换进度百分比。
已完成转换的文件列表。
widthnumber图片或动态 PPT 的宽度,单位为像素。
heightnumber图片或动态 PPT 的高度,单位为像素。
conversionFileUrlstring转换文件的 URL。
previewstring预览图地址。当发起转换时请求 Body 中 preview 设为 true 且 type 为 dynamic 时,才会返回该字段。
currentStepstring动态转换任务当前的步骤,返回值包括:
-
Extracting:提取资源。 -
Packaging:打包资源。 -
GeneratingPreview:生成预览图。 -
MediaTranscode:媒体转码。 当发起转换时请求 Body 中type为dynamic时,才会返回currentStep字段。
请求示例
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"
}
]
}
}