接口功能介绍
用户可在点播模式下通过本接口向云点播查询已经提交的转码任务状态。
接口约束
本接口的单用户QPS限制为20次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
URI
POST /task/status
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
taskId | 是 | String | 由提交任务返回的任务id | 0001#1a619cdd3f19406794f9663ee246cb7e |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | Integer | 本次请求的结果码 | 0 | |
message | 是 | String | 错误文本信息,创建成功时,为空字符串。 | "" | |
data | 是 | Object | 返回数据 | data |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
taskId | 是 | String | 任务ID | 0001#1a619cdd3f19406794f9663ee246cb7e | |
status | 是 | String | 状态,WORKING/DONE/WARNING/FAIL。 | WORKING | |
progress | 是 | Float | 0 ~ 1 之间的浮点数,代表当前任务执行进度。 | 0.3024 |
请求示例
请求体body
{
"taskId": "0001#1a619cdd3f19406794f9663ee246cb7e"
}
响应示例
{
"code": 0,
"message": "",
"data": {
"progress": 0.3024,
"taskId": "0001#1a619cdd3f19406794f9663ee246cb7e",
"status": "WORKING"
}
}
状态码
Http 状态码 | 状态码信息 | 状态码描述 |
---|---|---|
0 | 表示业务成功 | 表示业务成功 |
400 | 请求参数有误 | 请求参数有误 |
403 | 用户鉴权失败,用户无操作权限 | 用户鉴权失败,用户无操作权限 |
404 | 请求的资源不存在,输入错误的URL | 请求的资源不存在,输入错误的URL |
500 | 业务执行异常 | 业务执行异常 |
错误码
OpenAPI错误码请参考 错误码说明。