1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
创建任务接口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetTask。 |
Version | 是 | String | 公共参数,本接口取值:2025-08-06。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProjectId | 是 | String | 项目ID 示例值:2378393617299558400 |
TaskId | 是 | String | 任务ID 示例值:20250812174835531 取值可参考: 查询任务列表 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | Task | 任务详情 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取任务详情
获取任务详情
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetTask
<公共请求参数>
{
"ProjectId": "2417334454903762944",
"TaskId": "20250908225847483"
}
输出示例
{
"Response": {
"Data": {
"TaskBaseAttribute": {
"CreateTime": "2025-09-08 22:58:47",
"CreateUserUin": "100028579801",
"LastOpsTime": null,
"LastOpsUserName": null,
"LastUpdateTime": "2025-09-10 16:29:22",
"LastUpdateUserName": "zhanglin",
"OwnerUin": "100028579801",
"Status": "N",
"Submit": false,
"TaskDescription": "",
"TaskId": "20250908225847483",
"TaskLatestSubmitVersionNo": null,
"TaskLatestVersionNo": "V22",
"TaskName": "sh_241204_111248_copy",
"TaskTypeId": 35,
"UpdateUserUin": "100028579801",
"WorkflowId": "a5acf635-a297-458d-a311-14745662dcae",
"WorkflowName": "wf_ssh_test_01"
},
"TaskConfiguration": {
"BrokerIp": "any",
"BundleId": null,
"BundleInfo": null,
"CodeContent": "IyEvYmluL2Jhc2gKIyoqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKiMKIyNhdXRob3I6IHpoYW5nbGluCiMjY3JlYXRlIHRpbWU6IDIwMjQtMTItMDQgMTE6MTI6NDkKIyoqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKiMK",
"DataCluster": "",
"ResourceGroup": "20240416215649571819",
"ResourceGroupName": null,
"SourceServiceId": null,
"SourceServiceName": null,
"SourceServiceType": null,
"TargetServiceId": null,
"TargetServiceName": null,
"TargetServiceType": null,
"TaskExtConfigurationList": [
{
"ParamKey": "calendar_id",
"ParamValue": ""
},
{
"ParamKey": "python_type",
"ParamValue": "python3"
},
{
"ParamKey": "data_cluster",
"ParamValue": ""
},
{
"ParamKey": "calendar_open",
"ParamValue": "0"
},
{
"ParamKey": "calendar_name",
"ParamValue": ""
},
{
"ParamKey": "waitExecutionTotalTTL",
"ParamValue": "-1"
},
{
"ParamKey": "executionTTLStrategy",
"ParamValue": "fail"
},
{
"ParamKey": "bucket",
"ParamValue": "wedata-fusion-dev-1257305158"
},
{
"ParamKey": "specLabelConfItems",
"ParamValue": "eyJzcGVjTGFiZWxDb25mSXRlbXMiOltdfQ=="
},
{
"ParamKey": "waitExecutionTotalTTLStrategy",
"ParamValue": "fail"
},
{
"ParamKey": "python_sub_version",
"ParamValue": "python3"
},
{
"ParamKey": "ftp.file.name",
"ParamValue": "https://wedata-fusion-dev-1257305158.cos.ap-nanjing.myqcloud.com/datastudio/project/2417334454903762944/case_ssh/wf_ssh_test_01/sh_241204_111248_20250908225847483.sh"
},
{
"ParamKey": "tenantId",
"ParamValue": "1257305158"
},
{
"ParamKey": "region",
"ParamValue": "ap-nanjing"
},
{
"ParamKey": "enableKerberosLogin",
"ParamValue": "false"
},
{
"ParamKey": "extraInfo",
"ParamValue": "{\"fromMapping\":false}"
}
],
"TaskSchedulingParameterList": [],
"YarnQueue": null
},
"TaskSchedulerConfiguration": {
"AllowRedoType": "ALL",
"CalendarId": "",
"CalendarName": "",
"CalendarOpen": "0",
"CrontabExpression": "0 0 0 * * ? *",
"CycleType": "DAY_CYCLE",
"DownStreamDependencyConfigList": [],
"EndTime": "2099-12-31 23:59:59",
"EventListenerList": [
{
"EventBroadcastType": "BROADCAST",
"EventName": "event_241030",
"EventSubType": "DAY",
"PropertiesList": null
}
],
"ExecutionEndTime": "23:59",
"ExecutionStartTime": "00:00",
"ExecutionTTL": -1,
"InitStrategy": "T_PLUS_0",
"MaxRetryAttempts": 4,
"ParamTaskInList": [
{
"FromParamKey": "taskout_v1",
"FromTaskId": "20241204111252781",
"ParamDesc": "DATA_DEV_SIM_PROJ_01.sh_241204_111248.taskout_v1",
"ParamKey": "intask_v"
}
],
"ParamTaskOutList": [
{
"ParamKey": "asadad",
"ParamValue": "1"
}
],
"RetryWait": 5,
"RunPriority": 6,
"ScheduleRunType": 0,
"ScheduleTimeZone": "UTC+8",
"SelfDepend": "serial",
"StartTime": "2024-12-04 00:00:00",
"TaskOutputRegistryList": null,
"UpstreamDependencyConfigList": [
{
"DependencyStrategy": {
"PollingNullStrategy": "WAITING",
"TaskDependencyExecutingStrategies": null,
"TaskDependencyExecutingTimeoutValue": null
},
"MainCyclicConfig": "DAY",
"Offset": null,
"SubordinateCyclicConfig": "CURRENT_DAY",
"TaskId": "20241204111252781"
}
],
"WaitExecutionTotalTTL": "-1"
}
},
"RequestId": "b195b143-3336-403c-9cfb-dd1db04fedc3"
}
}
5. 开发者资源
腾讯云 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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound | 资源不存在。 |