DescribeTasks

Last updated: 2021-06-15 19:03:48

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 parameter. The value used for this API: DescribeTasks.
Version Yes String Common parameter. The value used for this API: 2018-07-17.
Region No String Common parameter. This parameter is not required for this API.
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.
    SubAppId No Integer Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.

    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, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting the task list

    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 Getting the task list - page turning

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

    Example3 Getting the task list - processing

    Input Example

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

    Output Example

    {
      "Response": {
        "TaskSet": [
          {
            "TaskId": "taskId7",
            "Status": "FINISH",
            "TaskType": "transcode",
            "CreateTime": "2018-12-27T13:57:15Z",
            "BeginProcessTime": "2018-12-27T13:57:15Z",
            "FinishTime": null,
            "SessionContext": "",
            "SessionId": "",
            "FileId": "528xx124"
          }
        ],
        "ScrollToken": null,
        "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.