接口功能介绍
用户可在点播模式下通过本接口向云点播查询转码任务。
接口约束
本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。
URI
POST /task/search
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| status | 否 | String | 任务状态，分别为 WORKING（工作中）、DONE（完成）、WARNING（执行结束）、FAIL（失败）。 | DONE | |
| createTime | 否 | Object | 用户的创建时间。 | createTime | |
| pageSize | 是 | Integer | 必填参数，每页的数量，由于任务数量多，请必须传入该参数，该参数最大数值为1000。 | ||
| pageIndex | 是 | Integer | 必填参数，页码，由0开始。 |
表 createTime
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| from | 否 | String | 用户的创建时间，格式为 yyyy-MM-dd HH:mm:ss。 |
2019-05-15 03:15:30 | |
| to | 否 | String | 用户的创建时间，格式为 yyyy-MM-dd HH:mm:ss。 |
2019-05-15 03:15:31 |
响应参数
返回值为一个 JsonArray，即使结果仅有一条也一样。
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | Integer | 本次请求的结果码 | 0 | |
| message | 是 | String | 错误文本信息，创建成功时，为空字符串。 | "" | |
| data | 是 | Array of Objects | 返回数据 | data |
表 data
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| taskId | 是 | String | 任务id | 0001#1a619cdd3f19406794f9663ee246cb7e | |
| callback | 否 | String | 回调地址 | http://callback.ctyun.cn/callback | |
| callbackMessage | 否 | String | 回调信息 | 详见下文示例 | |
| status | 是 | String | 状态 | DONE | |
| createTime | 是 | String | 创建时间 | 2019-06-16 13:34:03 | |
| videoId | 是 | String | 视频id | 34c71dba-f280-4f5e-a05f-f4daed837fef | |
| transcodeTemplateId | 是 | Integer | 转码模板id | 100000000003 | |
| watermarkId | 否 | Integer | 水印模板id | 100000000003 |
请求示例
请求体body
{
"status": "DONE",
"createTime": {
"from": "2019-05-15 03:15:30",
"to": "2019-05-15 03:15:30"
},
"pageSize": 10,
"pageIndex": 0
}
响应示例
{
"code": 0,
"message": "",
"data": [{
"taskId": "0001#1a619cdd3f19406794f9663ee246cb7e",
"callback": "http://callback.ctyun.cn/callback",
"callbackMessage": "{\"code\":\"0\",\"message\":\"任务成功\",\"successful\":true,\"trace\":{\"node\":\"10.xx.xx.xx\",\"xTranscodeAddr\":\"xs-shanghai-1\"},\"warning\":false}",
"status": "DONE",
"createTime": "2019-06-16 13:34:03",
"videoId": "34c71dba-f280-4f5e-a05f-f4daed837fef",
"transcodeTemplateId": 100000000003,
"watermarkId": 100000000003
}, {
"taskId": "0001#1a619cdd3f19406794f9663ee246cb7e",
"callback": "http://callback.ctyun.cn/callback",
"status": "WORKING",
"createTime": "2019-06-16 13:36:03",
"videoId": "34c71dba-f280-4f5e-a05f-f4daed837fee",
"transcodeTemplateId": 100000000003
}
]
}
状态码
| Http 状态码 | 状态码信息 | 状态码描述 |
|---|---|---|
| 0 | 表示业务成功 | 表示业务成功 |
| 400 | 请求参数有误 | 请求参数有误 |
| 403 | 用户鉴权失败，用户无操作权限 | 用户鉴权失败，用户无操作权限 |
| 404 | 请求的资源不存在，输入错误的URL | 请求的资源不存在，输入错误的URL |
| 500 | 业务执行异常 | 业务执行异常 |
错误码
OpenAPI错误码请参考 错误码说明。
