设置任务优先级
更新时间不可用
将待进行的指定任务移动至任务队列最前面或最后面。
PUT
https://api.netless.link/v5/projector/tasks/{uuid}/priority注意
调用文档转换 API 前,请确保:
-
已在声网控制台开启文档转图片或文档转网页服务并添加存储配置。详见开启互动白板配套服务。
-
已为待转换的文档生成一个公网可访问的 URL 地址。
uuidstring必填
转换任务的 UUID,即转换任务的唯一标识符,可通过调用发起文档转换 API 获取。
tokenstring必填
SDK Token,可以通过以下方式获取:
-
在声网控制台生成用于测试的 SDK Token,详见获取互动白板项目的安全密钥。
-
调用服务端 RESTful API, 详见生成 SDK Token。
-
在 App 服务端用代码生成,详见在 App 服务端生成 Token。
regionstring必填
指定处理该请求的数据中心,取值如下:
-
cn-hz:中国杭州,服务区覆盖中国大陆地区及其他数据中心未覆盖的区域。 -
us-sv:美国硅谷,服务区覆盖北美洲、南美洲。 -
sg:新加坡,服务区覆盖新加坡、东亚、东南亚。 -
in-mum:印度孟买,服务区覆盖印度。 -
eu:欧洲(法兰克福),服务区覆盖欧洲。
prioritystring必填
设定优先级,取值如下:
-
highest:最高,即移动至任务队列最前。 -
lowest:最低,即移动至任务队列末尾。
响应
若返回的状态码为 200 则表示请求成功。响应 Body 中包含本次请求的结果。
若返回的状态码不为 200 则表示请求失败。你可以参考响应状态码了解可能的原因。
响应 Body
uuidstring转换任务的 UUID,即转换任务的唯一标识符。
successboolean是否成功设置优先级:
-
true:设置成功。 -
false:设置失败。
请求示例
curl --request PUT \
--url "https://api.netless.link/v5/projector/tasks/:uuid/priority" \
--header 'token: <string>' \
--header 'region: cn-hz' \
--header 'Content-Type: application/json'响应示例
{
"uuid": "2fd2dxxxxx367e\"",
"success": true
}