Domain name for API request: vod.intl.tencentcloudapi.com.
A maximum of 100 requests can be initiated per second for this API.
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 VOD services on or after December 25, 2023, when accessing resources in VOD applications (whether the default application or a newly created application), this field must be set to the application ID. |
| Status | No | String | Filter criteria: task status. Available values: WAITING, PROCESSING, FINISH. |
| 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. Optional Sort.Field: |
| 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 |
| Parameter Name | Type | Description |
|---|---|---|
| TaskSet | Array of TaskSimpleInfo | Task summary 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. |
Obtain Task List
https://vod.intl.tencentcloudapi.com/?Action=DescribeTasks
&Status=FINISH
&Limit=5
&<Common request parameters>{
"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"
}
}Obtaining a List of Tasks Being Processed
https://vod.intl.tencentcloudapi.com/?Action=DescribeTasks
&Status=PROCESSING
&Limit=5
&<Common request parameters>{
"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"
}
}Obtaining a Task List and Paginating Results
https://vod.intl.tencentcloudapi.com/?Action=DescribeTasks
&Status=FINISH
&Limit=5
&ScrollToken=taskId6
&<Common request parameters>{
"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"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Parameter value error: invalid manual confirmation result. |
| UnauthorizedOperation | Unauthorized operation. |
文档反馈