查询任务列表
所有文档
menu

智能点播平台 VOD

查询任务列表

本接口用于查询任务列表,接口返回任务分页结果,任务信息仅包含基础信息。

接口限制:

  • marker 和 maxSize 两个参数影响单次分页查询结果数。特别注意:当这2个值都缺省时,本接口最多只返回前10条查询结果。
  • 只能查询到最近7天(7*24小时)内的任务。

请求结构

GET /v2/tasks?{请求参数} HTTP/1.1
connection: keep-alive
host: vod.bj.baidubce.com
content-type: application/json
x-bce-request-id: <bce-request-id>
x-bce-date: <utc-date-string>
authorization: <bce-authorization-string> 

在线调试

平台提供了 API在线调试平台-示例代码 ,用于帮助开发者调试接口,平台集成快速检索、查看在线调用的请求内容和返回结果、复制和下载示例代码等功能,简单易用,更多内容请查看API在线调试介绍。

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数 类型 是否必需 参数位置 描述
marker string Query参数 本次请求的marker,标记查询的起始位置,是上次marker机制查询返回的nextMarker,首次查询不提供本字段
maxSize string Query参数 本次请求返回的任务列表的最大元素个数,支持范围:[1-100],默认值:10
taskId string Query参数 任务ID
mediaId string Query参数 媒资ID
type string Query参数 任务类型,包括
  • WORKFLOW:工作流处理任务
  • PRESET:模板处理任务
  • COMPOSE:视频云剪辑任务
  • FETCH:媒资拉取任务
  • HIGHLIGHT_UNDERSTAND:精彩集锦视频理解任务
  • DWM_DETECT:数字水印提取任务
  • VIDEO_GENERATE:视频生成
status string Query参数 任务状态,包括
  • READY
  • RUNNING
  • SUCCESS
  • FAILED
  • FINISHED
其中FINISHED包含SUCCESS和FAILED两种可能,工作流和模版处理任务的终态均为FINISHED
beginTime string Query参数 任务创建时间的开始时间,大于等于开始时间,格式参考日期与时间规范
endTime string Query参数 任务创建时间的开始时间,小于等于结束时间,格式参考日期与时间规范

返回头域

除公共头域,无其它特殊头域。

返回参数

参数 类型 描述
isTruncated boolean 下一页是否还有数据
marker string 当前页查询的marker
nextMarker string 查询下一页的marker
data MediaTaskBasicInfo[] 此页数据

示例

获取处理失败的任务列表

第一次搜索时不需要指定marker,从起始开始搜索。

请求内容

GET /v2/tasks?maxSize=10&status=FAILED HTTP/1.1
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
content-type: application/json
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
x-bce-date: 2024-03-24T13:08:44Z
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-bce-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9

返回内容

HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8

{
    "data": [
        {
            "taskId": "tsk-emeqb9c1kmdd7rns",
            "mediaId": "mda-emcventhizk2yfbz",
            "type": "WORKFLOW",
            "status": "FAILED",
            "createTime": "2024-12-05T06:08:41Z",
            "finishTime": "2024-12-05T06:08:43Z"
        },
        {
            "taskId": "tsk-emeq6k7m52p8d2u0",
            "mediaId": "mda-emcvg7qrib0xq2y5",
            "type": "PRESET",
            "status": "FAILED",
            "createTime": "2024-12-05T06:08:27Z",
            "finishTime": "2024-12-05T06:08:37Z"
        }
    ],
    "marker": "tsk-emeqb9c1kmdd7rns",
    "nextMarker": "tsk-emeq6k7m52p8d2u0",
    "isTruncated": false
}

返回结果的isTruncated为false,表示没有下一页数据了,运行中的任务一共2个。

错误码

详见公共错误返回

上一篇
媒资管理相关接口
下一篇
查询任务详情