tencent cloud

APIs

文档APIsVideo on DemandTask Management APIsDescribeTasks

DescribeTasks

Download
聚焦模式
字号
最后更新时间： 2026-05-19 15:00:29

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

  • This API is used to query the task list;
  • If there are many data entries in the list, one single call of the API may not be able to pull the entire list. The ScrollToken parameter can be used to pull the list in batches;
  • Only tasks in the last three days (72 hours) can be queried.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeTasks.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
SubAppId No Integer VOD application ID. Customers who activate VOD services after December 25, 2023 must fill this field with the application ID when accessing resources in on-demand applications (whether default or newly created).
Status No String Filter condition: Task status. Available values: WAITING (Waiting), PROCESSING (Processing), FINISH (Completed).
FileId No String Filter criteria: file ID.
CreateTime No TimeRange Filter condition: Task creation time.
FinishTime No TimeRange Filter condition: Task end time.
Sort No SortBy Sorting method. Selectable fields for Sort.Field:
  • CreateTime Task creation time.
  • FinishTime Task end time.
    		•
    Limit No Integer Number of returned entries. Default value: 10. Maximum value: 100.
    ScrollToken No String Pagination identifier, used for batch pulling: When a single request cannot retrieve all data, the interface will return ScrollToken. Carry over in next request, will start obtaining from the next record.

    3. Output Parameters

    Parameter Name Type Description
    TaskSet Array of TaskSimpleInfo Task summary list.
    ScrollToken String Pagination identifier. When the request did not return all data, this field represents the next record ID. When this field is empty, it indicates that there is no more data.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Obtaining a Task List

    Obtain Task List

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=DescribeTasks
&Status=FINISH
&Limit=5
&<Common request parameters>

    Output Example

    {
    "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"
    }
}

    Example2 Obtaining a Task List and Paginating Results

    Obtaining a Task List and Paginating Results

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=DescribeTasks
&Status=FINISH
&Limit=5
&ScrollToken=taskId6
&<Common request parameters>

    Output Example

    {
    "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": "token-test",
        "RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
    }
}

    Example3 Obtaining a List of Tasks Being Processed

    Obtaining a List of Tasks Being Processed

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=DescribeTasks
&Status=PROCESSING
&Limit=5
&<Common request parameters>

    Output Example

    {
    "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": "token-test",
        "RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InvalidParameterValue Parameter value error.
    InvalidParameterValue.Status Incorrect parameter value: the value of human confirmation result is invalid.
    UnauthorizedOperation Unauthorized operation.
    上一篇: DescribeTaskDetail下一篇: ApplyUpload

    帮助和支持

    本页内容是否解决了您的问题？

    填写满意度调查问卷，共创更好文档体验。

    文档反馈