数据开发治理平台 WeData 任务发布

接口请求域名: wedata.tencentcloudapi.com 。推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。可以查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

相关产品
数据开发治理平台 WeData 产品页,含版本规格、价格与购买入口。

一、1. 接口描述

批量操作页面获取任务列表

默认接口请求频率限制:20次/秒。

二、2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeBatchOperateTask。
Version 是 String 公共参数,本接口取值:2021-08-20。
Region 是 String 公共参数,详见产品支持的 地域列表。
ProjectId 是 String 项目Id示例值:1460947863944517296
Page 是 String 页码示例值:1
Size 是 String 页号示例值:10
StatusList.N 否 Array of String 状态列表草稿:'NS','N','P','R'运行:''Y'停止:'F'冻结:'O'停止中:'T'示例值:["NS"]
OwnerNameList.N 否 Array of String 责任人名列表示例值:["wedata"]
WorkflowIdList.N 否 Array of String 工作流列表示例值:["860a23d6-ea4a-11ed-7909-bc97e105ba60"]
TaskNameFilter 否 String 任务名称搜索示例值:wedata
TaskTypeList.N 否 Array of String 任务类型列表示例值:["hive"]
FordIdList.N 否 Array of String 文件夹列表示例值:["860a23d6-ea4a-11ed-7909-bc97e105ba60"]
TaskIdFilter 否 String 任务Id搜索示例值:20230309172959474
OwnerNameFilter 否 String 责任人搜索示例值:wedata
SortItem 否 String 排序字段:UpdateTimeCreateTime示例值:CreateTime
SortType 否 String asc:升序desc:降序示例值:asc
DataEngineList.N 否 Array of String 引擎类型列表:三种SparkJobSparkSqlpresto示例值:["SparkJob"]
UserId 否 String 操作人名示例值:100028578877
OwnerId 否 String 1示例值:100028578877
TenantId 否 String 1示例值:12546362
DatasourceIdList.N 否 Array of String 数据源ID列表示例值:["7902"]
DatasourceTypeList.N 否 Array of String 数据源类型列表示例值:["mysql"]
CycleUnitList.N 否 Array of String 调度单位类型列表示例值:["D"]
CanSubmit 否 Boolean 是否筛选出可提交的任务示例值:true
TimeZone 否 String 返回时间字段需要转换的时区示例值:UTC+8
MinUpdateTime 否 Timestamp ISO8601 任务最后更新时间最小值,ISO8601格式,如2025-07-16T15:00:00+08:00示例值:2025-07-16T15:00:00+08:00
MaxUpdateTime 否 Timestamp ISO8601 任务最后更新时间最大值,ISO8601格式,如2025-07-17T15:00:00+08:00示例值:2025-07-17T15:00:00+08:00

三、3. 输出参数

参数名称 类型 描述
Data DescribeBatchOperateTaskPage 无注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

四、示例1 批量操作任务列表

批量操作任务列表

五、输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBatchOperateTask
<公共请求参数>
{
"ProjectId": "1464951627049713664",
"StatusList": [],
"OwnerNameList": [],
"WorkflowIdList": [],
"TaskNameFilter": "",
"TaskTypeList": [],
"FordIdList": [],
"TaskIdFilter": "",
"OwnerNameFilter": "",
"Page": "1",
"Size": "20"
}

六、输出示例

{
"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": "每天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"
}
}

七、示例2 查询失败

查询失败

八、输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBatchOperateTask
<公共请求参数>
{
"ProjectId": "1470547050521227264",
"StatusList": [],
"OwnerNameList": [],
"WorkflowIdList": [],
"TaskNameFilter": "",
"TaskTypeList": [],
"FordIdList": [],
"TaskIdFilter": "",
"OwnerNameFilter": "",
"Page": "1",
"Size": "20",
"SortItem": "",
"SortType": "",
"DataEngineList": []
}

九、输出示例

{
"Response": {
"Error": {
"Code": "FailedOperation",
"Message": "Connect to 9.164.239.24:54220 [/9.164.239.24] failed: Connection refused (Connection refused) executing POST http://data-source/cloud/datasource/v1/DescribeDataSourceWithoutInfo"
},
"RequestId": "2be30f31-ec77-4f92-abd1-0f5b9113fb0e"
}
}

十、腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便你从同一入口查询及使用腾讯云提供的所有 API 服务。

十一、API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

十二、SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

·Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

十三、命令行工具

·Tencent Cloud CLI 3.0

十四、6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
赞 (0)
上一篇 4天前
下一篇 4天前