接口功能介绍
用户可在托管模式下通过本接口向云点播查询转码任务。
接口约束
本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。
URI
POST /task/list
请求体 body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| taskId | 否 | String | 任务id。 | 34c71dba-f280-4f5e-a05f-f4daed837fef | |
| taskState | 否 | Array of Strings | 任务状态，"WORKING","SUCCESS","WARNING","FAIL","CANCELED"。 | WORKING | |
| originRegionName | 否 | Array of Strings | 资源池名称。 | 广东资源池1区 | |
| originVideoKey | 否 | String | 文件路径。 | test/video.mp4 | |
| startTime | 否 | String | 任务开始时间。 | 2021-03-09 10:00:00 | |
| endTime | 否 | String | 任务结束时间。 | 2021-03-10 10:00:00 | |
| pageIndex | 否 | Integer | 页码，不传时默认为0查询第一页。 | 0 | |
| pageSize | 否 | Integer | 每页的数量，不传默认为10表示每页10条数据。 | 10 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | Integer | 本次请求的结果码。 | 0 | |
| message | 是 | String | 错误文本信息，执行成功时，为空字符串。 | "" | |
| data | 是 | Array of Objects | 返回数据。 | data | |
| total | 是 | Integer | 查询结果总条数。 | 2 | |
| pageCount | 是 | Integer | 查询结果总页数。 | 1 |
表 data
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| taskId | 是 | String | 任务ID | 0200001#a1ca5c3f287a4be6806988139e522be5 | |
| workFlowId | 是 | String | 工作流ID | 100100000001 | |
| taskState | 是 | String | 任务状态 | WORKING | |
| taskMessage | 是 | String | 任务备注 | "" | |
| originRegionName | 是 | String | 资源池ID | 广东资源池1区 | |
| originVideoKey | 是 | String | 文件路径 | input/test/60s.mp4 | |
| createTime | 否 | String | 任务开始时间。 | 2021-03-09 10:00:00 | |
| taskEndTime | 否 | String | 任务结束时间。 | 2021-03-10 10:00:00 |
请求示例
请求体body
{
/*
* 列出搜索条件均为可选条件，默认查出所有任务，按创建时间倒序排列
* 条件均为精确匹配
*/
"taskId":"",
"taskState":["WORKING","SUCCESS","FAIL","CANCELED"],
"originRegionName":["广东资源池1区","福建资源池1区"],
"originVideoKey":"test/video.mp4",
"startTime":"2021-03-09 10:00:00",
"endTime":"2021-03-10 10:00:00",
"pageIndex":0,
"pageSize":10
}
响应示例
{
"code":"0",
"message":"",
"data":
[{
"taskId":"0200001#a1ca5c3f287a4be6806988139e522be5",
"workFlowId":"100100000001",
"taskState":"WORKING",
"taskMessage":"",
"originRegionName":"广东资源池1区",
"originVideoKey":"input/test/60s.mp4",
"createTime":"2021-03-10 08:08:08",
"taskEndTime":"2021-03-10 08:20:23"
},
{
"taskId":"0200001#e76e9f3c80d84219bc94efe9f16b57ee",
"workFlowId":"100100000001",
"taskState":"FAIL",
"taskMessage":"视频格式已破损或该格式转码不支持，转码失败",
"originRegionName":"广东资源池1区",
"originVideoKey":"input/test/功夫.mp4",
"createTime":"2021-03-10 09:10:08",
"taskEndTime":"2021-03-10 09:20:23"
}],
"total":"2",
"pageCount":"1"
}
状态码
| Http 状态码 | 状态码信息 | 状态码描述 |
|---|---|---|
| 0 | 表示业务成功 | 表示业务成功 |
| 400 | 请求参数有误 | 请求参数有误 |
| 403 | 用户鉴权失败，用户无操作权限 | 用户鉴权失败，用户无操作权限 |
| 404 | 请求的资源不存在，输入错误的URL | 请求的资源不存在，输入错误的URL |
| 500 | 业务执行异常 | 业务执行异常 |
错误码
OpenAPI错误码请参考 错误码说明。
