云点播获取任务列表-服务端 API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： vod.tencentcloudapi.com 。

该接口用于查询任务列表；
当列表数据比较多时，单次接口调用无法拉取整个列表，可通过 ScrollToken 参数，分批拉取；
只能查询到最近三天（72 小时）内的任务。

默认接口请求频率限制：100次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTasks。
Version	是	String	公共参数，本接口取值：2018-07-17。
Region	否	String	公共参数，此参数为可选参数。
SubAppId	否	Integer	点播应用 ID。从2023年12月25日起开通点播的客户，如访问点播应用中的资源（无论是默认应用还是新创建的应用），必须将该字段填写为应用 ID。示例值：145xxx
Status	否	String	过滤条件：任务状态，可选值：WAITING（等待中）、PROCESSING（处理中）、FINISH（已完成）。示例值：FINISH
FileId	否	String	过滤条件：文件 ID。示例值：528xxx
CreateTime	否	TimeRange	过滤条件：任务创建时间。
FinishTime	否	TimeRange	过滤条件：任务结束时间。
Sort	否	SortBy	排序方式。Sort.Field 可选： CreateTime 任务创建时间。 FinishTime 任务结束时间。
Limit	否	Integer	返回记录条数，默认值：10，最大值：100。示例值：5
ScrollToken	否	String	翻页标识，分批拉取时使用：当单次请求无法拉取所有数据，接口将会返回 ScrollToken，下一次请求携带该 Token，将会从下一条记录开始获取。示例值：taskId6

3. 输出参数

参数名称	类型	描述
TaskSet	Array of TaskSimpleInfo	任务概要列表。
ScrollToken	String	翻页标识，当请求未返回所有数据，该字段表示下一条记录的 ID。当该字段为空，说明已无更多数据。示例值：taskId6
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取任务列表

获取任务列表

输入示例

https://vod.tencentcloudapi.com/?Action=DescribeTasks
&Status=FINISH
&Limit=5
&<公共请求参数>

输出示例

{
    "Response": {
        "TaskSet": [
            {
                "TaskId": "taskId1",
                "Status": "FINISH",
                "TaskType": "transcode",
                "CreateTime": "2018-12-27T13:57:15Z",
                "BeginProcessTime": "2018-12-27T13:57:15Z",
                "FinishTime": "2018-12-27T13:57:15Z",
                "SessionContext": "",
                "SessionId": "",
                "FileId": "528xx123"
            },
            {
                "TaskId": "taskId2",
                "Status": "FINISH",
                "TaskType": "transcode",
                "CreateTime": "2018-12-27T13:57:15Z",
                "BeginProcessTime": "2018-12-27T13:57:15Z",
                "FinishTime": "2018-12-27T13:57:15Z",
                "SessionContext": "",
                "SessionId": "",
                "FileId": "528xx124"
            },
            {
                "TaskId": "taskId3",
                "Status": "FINISH",
                "TaskType": "transcode",
                "CreateTime": "2018-12-27T13:57:15Z",
                "BeginProcessTime": "2018-12-27T13:57:15Z",
                "FinishTime": "2018-12-27T13:57:15Z",
                "SessionContext": "",
                "SessionId": "",
                "FileId": "528xx125"
            },
            {
                "TaskId": "taskId4",
                "Status": "FINISH",
                "TaskType": "transcode",
                "CreateTime": "2018-12-27T13:57:15Z",
                "BeginProcessTime": "2018-12-27T13:57:15Z",
                "FinishTime": "2018-12-27T13:57:15Z",
                "SessionContext": "",
                "SessionId": "",
                "FileId": "528xx126"
            },
            {
                "TaskId": "taskId5",
                "Status": "FINISH",
                "TaskType": "transcode",
                "CreateTime": "2018-12-27T13:57:15Z",
                "BeginProcessTime": "2018-12-27T13:57:15Z",
                "FinishTime": "2018-12-27T13:57:15Z",
                "SessionContext": "",
                "SessionId": "",
                "FileId": "528xx127"
            }
        ],
        "ScrollToken": "taskId6",
        "RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
    }
}

示例2 获取任务列表-翻页

获取任务列表-翻页

输入示例

https://vod.tencentcloudapi.com/?Action=DescribeTasks
&Status=FINISH
&Limit=5
&ScrollToken=taskId6
&<公共请求参数>

输出示例

{
    "Response": {
        "TaskSet": [
            {
                "TaskId": "taskId6",
                "Status": "FINISH",
                "TaskType": "transcode",
                "CreateTime": "2018-12-27T13:57:15Z",
                "BeginProcessTime": "2018-12-27T13:57:15Z",
                "FinishTime": "2018-12-27T13:57:15Z",
                "SessionContext": "",
                "SessionId": "",
                "FileId": "528xx124"
            }
        ],
        "ScrollToken": "abc",
        "RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
    }
}

示例3 获取任务列表-处理中

获取任务列表-处理中

输入示例

https://vod.tencentcloudapi.com/?Action=DescribeTasks
&Status=PROCESSING
&Limit=5
&<公共请求参数>

输出示例

{
    "Response": {
        "TaskSet": [
            {
                "TaskId": "taskId7",
                "Status": "PROCESSING",
                "TaskType": "transcode",
                "CreateTime": "2018-12-27T13:57:15Z",
                "BeginProcessTime": "2018-12-27T13:57:15Z",
                "FinishTime": "0001-01-01T00:00:00Z",
                "SessionContext": "",
                "SessionId": "",
                "FileId": "528xx124"
            }
        ],
        "ScrollToken": "abc",
        "RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
FailedOperation.InvalidVodUser	没有开通点播业务。
InternalError	内部错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.Status	参数值错误：人工确认结果取值非法。
UnauthorizedOperation	未授权操作。

获取任务列表

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 获取任务列表

输入示例

输出示例

示例2 获取任务列表-翻页

输入示例

输出示例

示例3 获取任务列表-处理中

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码