tencent cloud

All product documents
Video on Demand
DocumentationVideo on DemandServer APIsTask Management APIsDescribeTasks
DescribeTasks
Download PDF
Last updated: 2024-03-27 16:09:00
DescribeTasks
Last updated: 2024-03-27 16:09:00
Download PDF

1. API Description

Domain name for API request: vod.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 The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
Status No String Filter: Task status. Valid values: WAITING (waiting), PROCESSING (processing), FINISH (completed).
FileId No String Filter: file ID.
CreateTime No TimeRange Filter: task creation time.
FinishTime No TimeRange Filter: task end time.
Sort No SortBy Sort field. Valid values:
  • CreateTime: task creation time
  • FinishTime: task end time
    		•
    Limit No Integer Number of entries to be returned. 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 overview list.
    ScrollToken String Scrolling 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 Querying tasks

    This example shows you how to query tasks.

    Input Example

    https://vod.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 Querying tasks and paginating the results

    This example shows you how to query tasks and paginate the results.

    Input Example

    https://vod.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": "abc",
        "RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
    }
}

    Example3 Querying tasks being processed

    This example shows you how to query tasks that are being processed.

    Input Example

    https://vod.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": "abc",
        "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 Incorrect parameter value.
    InvalidParameterValue.Status Incorrect parameter value: the value of human confirmation result is invalid.
    UnauthorizedOperation Unauthorized operation.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback

    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Hong Kong, China
    +852 800 906 020 (Toll Free)
    United States
    +1 844 606 0804 (Toll Free)
    United Kingdom
    +44 808 196 4551 (Toll Free)
    Canada
    +1 888 605 7930 (Toll Free)
    Australia
    +61 1300 986 386 (Toll Free)
    EdgeOne hotline
    +852 300 80699
    More local hotlines coming soon