1. API Description
Domain name for API request: wedata.intl.tencentcloudapi.com.
Batch operation page to retrieve task list
A maximum of 20 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.
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: DescribeBatchOperateTask. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2021-08-20. |
| Region |
Yes |
String |
Common Params. For more information, please see the list of regions supported by the product. |
| ProjectId |
Yes |
String |
Project ID |
| Page |
Yes |
String |
Page Number |
| Size |
Yes |
String |
Page Number |
| StatusList.N |
No |
Array of String |
Status ListDraft: 'NS','N','P','R' Running: 'Y' Stopped: 'F' Frozen: 'O' Stopping: 'T' |
| OwnerNameList.N |
No |
Array of String |
List of Responsible Persons |
| WorkflowIdList.N |
No |
Array of String |
Workflow List |
| TaskNameFilter |
No |
String |
Task Name Search |
| TaskTypeList.N |
No |
Array of String |
Task Type List |
| FordIdList.N |
No |
Array of String |
Folder List |
| TaskIdFilter |
No |
String |
Task ID Search |
| OwnerNameFilter |
No |
String |
Responsible Person Search |
| SortItem |
No |
String |
Sort Fields: UpdateTime CreateTime |
| SortType |
No |
String |
asc: Ascending desc: Descending |
| DataEngineList.N |
No |
Array of String |
Engine Type List: Three Types SparkJob SparkSql presto |
| UserId |
No |
String |
Operator Name |
| OwnerId |
No |
String |
1 |
| TenantId |
No |
String |
1 |
| DatasourceIdList.N |
No |
Array of String |
Data Source ID List |
| DatasourceTypeList.N |
No |
Array of String |
Data Source Type List |
| CycleUnitList.N |
No |
Array of String |
Scheduling Unit Type List |
| CanSubmit |
No |
Boolean |
Filter out tasks that can be submitted? |
3. Output Parameters
| Parameter Name |
Type |
Description |
| Data |
DescribeBatchOperateTaskPage |
NoNote: This field may return null, indicating that no valid value can be obtained. |
| 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 Query failed
Query failed
POST / HTTP/1.1
Host: wedata.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBatchOperateTask
<Common request parameters>
{
"ProjectId": "1470547050521227264",
"StatusList": [],
"OwnerNameList": [],
"WorkflowIdList": [],
"TaskNameFilter": "",
"TaskTypeList": [],
"FordIdList": [],
"TaskIdFilter": "",
"OwnerNameFilter": "",
"Page": "1",
"Size": "20",
"SortItem": "",
"SortType": "",
"DataEngineList": []
}
Output Example
{
"Response": {
"Data": {
"Items": [
{
"CreateTime": "2023-03-21 19:39:28",
"CycleUnit": "D",
"DataEngine": null,
"DatasourceId": null,
"DatasourceType": null,
"FolderId": "29c8c4f2-7953-11ed-8346-e43d1ad5f5f0",
"FolderName": "jayshi",
"InCharge": ";zheyuwang;",
"ScheduleDesc": "Execute once daily at 00:00",
"Status": "Y",
"Submit": 0,
"TaskId": "20230321193928764",
"TaskName": "20230321",
"TaskTypeDesc": "Shell",
"TaskTypeId": 35,
"UpdateTime": "2024-03-14 14:28:09",
"WorkflowId": "0302ca9b-c7dd-11ed-8346-e43d1ad5f5f0",
"WorkflowName": "dataflow_20230321"
}
],
"PageCount": 70,
"TotalCount": 700
},
"RequestId": "df914542-61ca-4c16-80d3-c2a9211425c7"
}
}
Example2 Batch Operation Task List
Batch Operation Task List
POST / HTTP/1.1
Host: wedata.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBatchOperateTask
<Common request parameters>
{
"ProjectId": "1464951627049713664",
"StatusList": [],
"OwnerNameList": [],
"WorkflowIdList": [],
"TaskNameFilter": "",
"TaskTypeList": [],
"FordIdList": [],
"TaskIdFilter": "",
"OwnerNameFilter": "",
"Page": "1",
"Size": "20"
}
Output Example
{
"Response": {
"Data": {
"Items": [
{
"CreateTime": "2023-03-21 19:39:28",
"CycleUnit": "D",
"DataEngine": null,
"DatasourceId": null,
"DatasourceType": null,
"FolderId": "29c8c4f2-7953-11ed-8346-e43d1ad5f5f0",
"FolderName": "jayshi",
"InCharge": ";zheyuwang;",
"ScheduleDesc": "Execute once every day at 00:00",
"Status": "Y",
"Submit": 0,
"TaskId": "20230321193928764",
"TaskName": "20230321",
"TaskTypeDesc": "Shell",
"TaskTypeId": 35,
"UpdateTime": "2024-03-14 14:28:09",
"WorkflowId": "0302ca9b-c7dd-11ed-8346-e43d1ad5f5f0",
"WorkflowName": "dataflow_20230321"
}
],
"PageCount": 70,
"TotalCount": 700
},
"RequestId": "df914542-61ca-4c16-80d3-c2a9211425c7"
}
}
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 |
| AuthFailure |
CAM Signature/Authentication Error. |
| FailedOperation |
Operation Failure. |