1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
查询任务具体详情【新】
默认接口请求频率限制：60次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTaskDetailDs。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| TaskId | 是 | String | 任务Id 示例值：20250227112841503 |
| ProjectId | 否 | String | 项目Id 示例值：1470547050521227264 |
| TaskAlarmStatus | 否 | Integer | 已废弃，无需填写 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | TaskDsDTO | 任务详情1 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询任务详情
查询任务详情
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskDetailDs
<公共请求参数>
{
"TaskId": "20250227112841503",
"ProjectId": "1470547050521227264"
}输出示例
{
"Response": {
"Data": {
"Alarm": null,
"BrokerIp": "any",
"ClusterId": null,
"ConcurrentStrategy": null,
"ContentType": null,
"CreateTime": "2025-02-27 11:28:41",
"Creater": "kevinnie",
"CrontabExpression": "",
"CycleDependencyConfigList": null,
"CycleStep": 1,
"CycleType": "DAY_CYCLE",
"DelayTime": 0,
"DependencyConfigList": [
{
"DependencyStrategy": {
"PollingNullStrategy": "WAITING"
},
"MainCyclicConfig": "DAY",
"Offset": null,
"ParentTask": {
"Alarm": null,
"BrokerIp": "any",
"ClusterId": null,
"ConcurrentStrategy": 0,
"ContentType": null,
"CreateTime": "2023-04-24 12:47:03",
"Creater": "wineliu",
"CrontabExpression": null,
"CycleDependencyConfigList": null,
"CycleStep": 5,
"CycleType": "MINUTE_CYCLE",
"DelayTime": 0,
"DependencyConfigList": null,
"DependencyRel": "and",
"DependencyWorkflow": "no",
"EndTime": "2024-07-22 23:59:59",
"EventListenerConfig": null,
"EventPublisherConfig": null,
"ExecutionEndTime": "23:59",
"ExecutionStartTime": "00:00",
"ExecutionTTL": -1,
"FolderId": null,
"FolderName": null,
"ImportErrMsg": null,
"ImportResult": null,
"InCharge": "wineliu",
"InChargeId": "100029386024",
"InstanceInitStrategy": "T_PLUS_0",
"LastSchedulerCommitTime": null,
"LastUpdate": "2024-12-19 21:46:21",
"LeftCoordinate": 337,
"LinkId": "6e572ef4-f4bb-11ef-8ec8-b8599f277de5",
"MaxDateTime": null,
"MaxRetryAttempts": null,
"MinDateTime": null,
"NewOrUpdate": null,
"NormalizedJobStartTime": null,
"Notes": "",
"OwnId": "100028448903",
"ParamInList": null,
"ParamOutList": null,
"Params": null,
"ProductName": "DATA_DEV",
"ProjectId": "1460947878944567296",
"ProjectIdent": null,
"ProjectName": "调度dev验证项目_new",
"Properties": null,
"RealWorkflowId": null,
"RecoverFreezeStartTime": null,
"RecycleTips": null,
"RecycleUser": null,
"ResourceGroup": "20240222212719833743",
"ResourceGroupName": null,
"Retriable": 1,
"RetryWait": null,
"RunPriority": 6,
"ScheduleRunType": 0,
"ScheduleTimeZone": null,
"SchedulerDesc": null,
"ScriptChange": false,
"SelfDepend": "orderly",
"SourceServer": null,
"SourceServiceId": null,
"SourceServiceName": null,
"SourceServiceType": null,
"StartTime": "2024-07-21 00:00:00",
"StartupTime": 0,
"Status": "F",
"Submit": false,
"TargetServer": null,
"TargetServiceId": null,
"TargetServiceType": null,
"TaskAction": "",
"TaskAutoSubmit": null,
"TaskExt": null,
"TaskFolderId": null,
"TaskId": "20230424124702936",
"TaskLinkInfo": null,
"TaskName": "asdfasdf",
"TaskRegisterOutputTable": null,
"TaskType": {
"BrokerParallelism": 10,
"CreateTime": "2022-02-12 11:13:41",
"DefaultAliveWait": 720,
"DoRedoParallelism": 10000,
"DowngradePriorityTries": 2,
"ExcludeCommonLib": false,
"FileType": null,
"InCharge": "admin",
"KillAble": 0,
"ParamList": "<parameters><parameter><name>hdpClient</name><value>/usr/hdp/current/hadoop-client</value></parameter><parameter><name>hiveClient</name><value>/usr/hdp/current/hive-client</value></parameter></parameters>",
"PollingSeconds": 5,
"PostHooks": null,
"RetryLimit": 5,
"RetryWait": 5,
"RunJarName": "IdexShell.jar",
"SelectFilePath": null,
"SourceServerType": null,
"TargetServerType": null,
"TaskParallelism": 10,
"TaskTypeExtension": null,
"TypeDesc": "Shell",
"TypeId": 35,
"TypeSort": "数据计算"
},
"Tasks": null,
"TenantId": "1315051789",
"TopCoordinate": 265,
"TryLimit": 5,
"UpdateTime": "2024-07-21 16:54:10",
"UpdateUser": "jayshi",
"UpdateUserId": "100028578933",
"UserFileId": "7353e5e8-4a87-42c8-9872-8d13baf94429",
"UserId": "100029386024",
"VersionDesc": null,
"VirtualFlag": false,
"VirtualTaskId": null,
"VirtualTaskStatus": null,
"WorkflowId": "c55762aa-b1b8-11ed-8909-bc97e105ba60",
"WorkflowName": "aaaaa",
"YarnQueue": null
},
"SonTask": null,
"SubordinateCyclicConfig": "PREVIOUS_DAY"
}
],
"DependencyRel": "and",
"DependencyWorkflow": "no",
"EndTime": "2099-12-31 23:59:59",
"EventListenerConfig": null,
"EventPublisherConfig": null,
"ExecutionEndTime": "23:59",
"ExecutionStartTime": "00:00",
"ExecutionTTL": -1,
"FolderId": "da0a80d7-b671-11ee-8ec8-b8599f277de5",
"FolderName": "00leo",
"ImportErrMsg": null,
"ImportResult": null,
"InCharge": "kevinnie",
"InChargeId": "100028578763",
"InstanceInitStrategy": "T_PLUS_0",
"LastSchedulerCommitTime": null,
"LastUpdate": "2025-02-27 16:27:37",
"LeftCoordinate": 331,
"LinkId": null,
"MaxDateTime": null,
"MaxRetryAttempts": 4,
"MinDateTime": null,
"NewOrUpdate": null,
"NormalizedJobStartTime": null,
"Notes": "",
"OwnId": "100028448903",
"ParamInList": null,
"ParamOutList": null,
"Params": null,
"ProductName": "DATA_DEV",
"ProjectId": "1470547050521227264",
"ProjectIdent": "wedata_dev_new",
"ProjectName": "wedata数据开发_新",
"Properties": null,
"RealWorkflowId": null,
"RecoverFreezeStartTime": null,
"RecycleTips": null,
"RecycleUser": null,
"ResourceGroup": "20240222212719833743",
"ResourceGroupName": null,
"Retriable": 1,
"RetryWait": 5,
"RunPriority": 6,
"ScheduleRunType": 0,
"ScheduleTimeZone": "UTC+5",
"SchedulerDesc": "EveryDay03:00ExecuteOnce",
"ScriptChange": true,
"SelfDepend": "serial",
"SourceServer": null,
"SourceServiceId": null,
"SourceServiceName": null,
"SourceServiceType": ";spark;",
"StartTime": "2025-02-27 00:00:00",
"StartupTime": 0,
"Status": "N",
"Submit": false,
"TargetServer": null,
"TargetServiceId": null,
"TargetServiceType": null,
"TaskAction": "",
"TaskAutoSubmit": null,
"TaskExt": {
"DryRunExtAttributes": null,
"DryRunParameter": null,
"Properties": [
{
"ParamKey": "bucket",
"ParamValue": "wedata-fusion-dev-1257305158"
},
{
"ParamKey": "calendar_id",
"ParamValue": ""
},
{
"ParamKey": "specLabelConfItems",
"ParamValue": "eyJzcGVjTGFiZWxDb25mSXRlbXMiOltdfQ=="
},
{
"ParamKey": "python_type",
"ParamValue": "python3"
},
{
"ParamKey": "ftp.file.name",
"ParamValue": "https://wedata-fusion-dev-1257305158.cos.ap-nanjing.myqcloud.com/datastudio/project/1470547050521227264/00leo/testjiek/testpython1_20250227112840742605.py"
},
{
"ParamKey": "tenantId",
"ParamValue": "1257305158"
},
{
"ParamKey": "calendar_open",
"ParamValue": "0"
},
{
"ParamKey": "calendar_name",
"ParamValue": ""
},
{
"ParamKey": "region",
"ParamValue": "ap-nanjing"
},
{
"ParamKey": "waitExecutionTotalTTL",
"ParamValue": "-1"
},
{
"ParamKey": "extraInfo",
"ParamValue": "{\"fromMapping\":false}"
}
],
"TaskId": "20250227112841503"
},
"TaskFolderId": null,
"TaskId": "20250227112841503",
"TaskLinkInfo": null,
"TaskName": "testpython1",
"TaskRegisterOutputTable": null,
"TaskType": {
"BrokerParallelism": 10,
"CreateTime": "2022-02-12 11:13:43",
"DefaultAliveWait": 720,
"DoRedoParallelism": 10000,
"DowngradePriorityTries": 2,
"ExcludeCommonLib": false,
"FileType": null,
"InCharge": "admin",
"KillAble": 0,
"ParamList": "<parameters><parameter><name>hive</name><value>/usr/bin/beeline</value></parameter></parameters>",
"PollingSeconds": 2,
"PostHooks": null,
"RetryLimit": 5,
"RetryWait": 5,
"RunJarName": "Python.jar",
"SelectFilePath": null,
"SourceServerType": "spark",
"TargetServerType": null,
"TaskParallelism": 10,
"TaskTypeExtension": [
{
"TaskTypeExtKey": "endDate",
"TaskTypeExtValue": {
"CandidateTexts": "",
"CandidateValues": "",
"Candidates": null,
"ConfLevel": 2,
"CopyKey": 1,
"DefaultFlag": 1,
"DefaultValue": "",
"InputType": "date",
"IsMandatory": 0,
"MaxValue": 0,
"MinValue": 0,
"PropDesc": "任务停止生成实例的时间",
"PropLabel": "终止时间",
"PropName": "endDate",
"RankId": 19,
"Regex": ".*",
"Tip": "need to fulltill rex",
"TypeId": 30,
"ValueType": "date",
"VisibleFlag": 1
}
},
{
"TaskTypeExtKey": "brokerIp",
"TaskTypeExtValue": {
"CandidateTexts": "",
"CandidateValues": "",
"Candidates": null,
"ConfLevel": 2,
"CopyKey": 1,
"DefaultFlag": 1,
"DefaultValue": "any",
"InputType": "string",
"IsMandatory": 0,
"MaxValue": 0,
"MinValue": 0,
"PropDesc": "任务实例执行所在机器ip",
"PropLabel": "代理IP",
"PropName": "brokerIp",
"RankId": 19,
"Regex": ".*",
"Tip": "need to fulltill rex",
"TypeId": 30,
"ValueType": "string",
"VisibleFlag": 1
}
},
{
"TaskTypeExtKey": "python_type",
"TaskTypeExtValue": {
"CandidateTexts": "python2,python3",
"CandidateValues": "python2,python3",
"Candidates": null,
"ConfLevel": 1,
"CopyKey": 1,
"DefaultFlag": 1,
"DefaultValue": "python2",
"InputType": "select-single",
"IsMandatory": 1,
"MaxValue": 0,
"MinValue": 0,
"PropDesc": "Python类型",
"PropLabel": "Python类型\n",
"PropName": "python_type",
"RankId": 10,
"Regex": ".*",
"Tip": "need to fulltill rex",
"TypeId": 30,
"ValueType": "string",
"VisibleFlag": 1
}
},
{
"TaskTypeExtKey": "cycleNum",
"TaskTypeExtValue": {
"CandidateTexts": "",
"CandidateValues": "",
"Candidates": null,
"ConfLevel": 2,
"CopyKey": 1,
"DefaultFlag": 1,
"DefaultValue": "1",
"InputType": "int",
"IsMandatory": 0,
"MaxValue": 0,
"MinValue": 0,
"PropDesc": "间隔多少周期执行一次(若是天任务，步数为2，每两天执行一次)",
"PropLabel": "步长",
"PropName": "cycleNum",
"RankId": 19,
"Regex": "^[1-9]+[0-9]*?$",
"Tip": "必须是正整数",
"TypeId": 30,
"ValueType": "int",
"VisibleFlag": 1
}
},
{
"TaskTypeExtKey": "ftp.file.name",
"TaskTypeExtValue": {
"CandidateTexts": "",
"CandidateValues": "",
"Candidates": null,
"ConfLevel": 1,
"CopyKey": 1,
"DefaultFlag": 1,
"DefaultValue": "",
"InputType": "button-file",
"IsMandatory": 1,
"MaxValue": 0,
"MinValue": 0,
"PropDesc": "任务执行资源,不要将资源放到子目录",
"PropLabel": "python脚本",
"PropName": "ftp.file.name",
"RankId": 11,
"Regex": "zip$",
"Tip": "必须是zip结尾文件",
"TypeId": 30,
"ValueType": "string",
"VisibleFlag": 1
}
},
{
"TaskTypeExtKey": "taskPriority",
"TaskTypeExtValue": {
"CandidateTexts": "高,中,低",
"CandidateValues": "4,5,6",
"Candidates": null,
"ConfLevel": 2,
"CopyKey": 1,
"DefaultFlag": 1,
"DefaultValue": "6",
"InputType": "single-select",
"IsMandatory": 0,
"MaxValue": 0,
"MinValue": 0,
"PropDesc": ">高优先级任务会优先下发（只对同一类型的任务有效）",
"PropLabel": "任务调度优先级",
"PropName": "taskPriority",
"RankId": 99,
"Regex": ".*",
"Tip": "need to fulltill rex",
"TypeId": 30,
"ValueType": "string",
"VisibleFlag": 1
}
},
{
"TaskTypeExtKey": "tryLimit",
"TaskTypeExtValue": {
"CandidateTexts": "",
"CandidateValues": "",
"Candidates": null,
"ConfLevel": 2,
"CopyKey": 1,
"DefaultFlag": 1,
"DefaultValue": "5",
"InputType": "int",
"IsMandatory": 0,
"MaxValue": 0,
"MinValue": 0,
"PropDesc": "任务实例尝试运行次数上\n限（设置为0，任务不下发）",
"PropLabel": "最大可运行次数",
"PropName": "tryLimit",
"RankId": 19,
"Regex": "^[1-9]+[0-9]*?$",
"Tip": "必须是正整数",
"TypeId": 30,
"ValueType": "int",
"VisibleFlag": 1
}
}
],
"TypeDesc": "Python",
"TypeId": 30,
"TypeSort": "数据计算"
},
"Tasks": null,
"TenantId": "1315051789",
"TopCoordinate": 85,
"TryLimit": 5,
"UpdateTime": "2025-02-27 11:28:58",
"UpdateUser": "kevinnie",
"UpdateUserId": "100028578763",
"UserFileId": null,
"UserId": "100028578763",
"VersionDesc": null,
"VirtualFlag": false,
"VirtualTaskId": null,
"VirtualTaskStatus": null,
"WorkflowId": "05bee18d-9c89-480b-b0b0-18f979f33a81",
"WorkflowName": "testjiek",
"YarnQueue": null
},
"RequestId": "327eb57c-3810-4989-bf4c-0bb6584762d4"
}
}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: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter.ClientIpNotAuthorized | ClientIp未被授权。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
