tencent cloud

APIs

DocumentaçãoAPIsVideo on DemandTask Management APIsDescribeTasks

DescribeTasks

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-22 22:24:55

1. API Description

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

  • This API is used to query the task list.
  • When the list contains a large amount of data, a single API call cannot pull the entire list. You can use the ScrollToken parameter to pull in batches.
  • Only tasks from 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

Video-on-demand (VOD) application ID. For customers who activate on-demand services from December 25, 2023, if they access resources in on-demand applications (whether the default application or a newly created application), this field must be filled in as the application ID.
Status No String

Filter criteria: task status. Available values: WAITING, PROCESSING, FINISH.
FileId No String

Filtering Conditions: file ID.
CreateTime No TimeRange

Filter condition: task creation time.
FinishTime No TimeRange

Filter condition: task end time.
Sort No SortBy

Sorting method. Sort.Field options:

  • CreateTime: task creation time.
  • FinishTime: task end time.
    		•
    Limit No Integer

    Number of returned entries. Default value: 10. Maximum value: 100.
    ScrollToken No String

    Scrolling identifier which is used for pulling in batches. If a single request cannot pull all the data entries, the API will return ScrollToken, and if the next request carries it, the next pull will start from the next entry.

    3. Output Parameters

    Parameter Name Type Description
    TaskSet Array of TaskSimpleInfo

    Task summary list.
    ScrollToken String

    Pagination identifier. If a request does not return all the data entries, this field indicates the ID of the next entry. If this field is empty, 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 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"
    }
}

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

    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 enabled.
    InternalError Internal error.
    InvalidParameterValue Parameter value error.
    InvalidParameterValue.Status Parameter value error: invalid manual confirmation result.
    UnauthorizedOperation Unauthorized operation.
    Anterior: DescribeTaskDetailPróximo: ApplyUpload

    Ajuda e Suporte

    Esta página foi útil?

    comentários

    Search
      Enter keywords to search documentation