查询任务列表

最近更新时间:2019-07-15 10:46:48

接口名称

GetTaskList

功能说明

  • 查询任务列表。
  • 当列表数据比较多时,单次接口调用无法拉取整个列表,可以通过参数next分批拉取。
  • 只能查询到三天(72小时)内的任务。

请求方式

请求域名

vod.api.qcloud.com

最高调用频率

100次/分钟

参数说明

参数名称 必填 类型 说明
fileId String 文件 ID,如果填写该字段,则只会查询该文件的任务列表。
status String 任务状态,取值 WAITING、PROCESSING 和 FINISH。
maxCount Integer 本次查询返回多少个数据,范围:10 - 100,不填默认为10。
next String 分批拉取时使用。当列表数据比较多时,单次接口调用无法拉取整个列表,这时会返回拉取的最后一个数据 ID,下次请求携带该 ID,将会从该 ID 下一个数据开始拉取。
COMMON_PARAMS - 请参见 公共参数

请求示例

https://vod.api.qcloud.com/v2/index.php?Action=GetTaskList
&next=59b61160f78939626efd644b
&startTime=1505294672
&endTime=1505295672
&status=Processing
&COMMON_PARAMS

接口应答

参数说明

参数名称 类型 说明
code Integer 错误码,0:成功;其他值:失败。
message Integer 错误信息。
data Object 任务信息数据。
data.next String 当列表比较多时,单次接口调用无法拉取全部列表,这时会返回拉取的最后一个数据 ID,下次请求携带该 ID,将会从该 ID 下一个数据开始拉取,如果为空表示已经拉完最后一个数据。
data.status String 任务状态,取值 WAITING、PROCESSING 和 FINISH。
data.taskList Array 任务信息列表。
data.taskList.vodTaskId String 任务 ID。
data.taskList.type String 任务类型。
data.taskList.createTime Integer 任务创建时间(Unix 时间戳)。
data.taskList.beginProcessTime Integer 任务开始执行的时间(Unix 时间戳),若任务还在排队中,该值为0。
data.taskList.finishTime Integer 任务信息最近更新时间(Unix 时间戳),若任务还未完成,该值为0。

错误码说明

错误码 含义说明
4000 - 7000 请参见 公共错误码
1000 参数非法。
10027 系统内部错误。

应答示例

{
    "code": 0,
    "message": "",
    "data": {
        "status": "PROCESSING",
        "next": "68bfa4c7b3244d1c3acb5b70",
        "taskList": [
            {
                "vodTaskId": "1251132654-Procedure-d7c9631c15ecf653b1ff67e34cb046ff",
                "type": "procedure",
                "createTime": 1485156352,
                "beginProcessTime": 1485156354,
                "finishTime": 1485156352
            },
            {
                "type": "transcode",
                "vodTaskId": "1251132654-Procedure-d7c9631c15ecf653b1ff67e34cb046bb",
                "createTime": 1485156352,
                "beginProcessTime": 1485156354,
                "finishTime": 1485156352
            }
        ]
    }
}