1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
获取实例列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetTaskInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目ID 示例值：1531612696090365952 |
| InstanceKey | 是 | String | 实例唯一标识 示例值：20240627201611119_2025-03-20 00:00:00 |
| ScheduleTimeZone | 否 | String | 时区 timeZone, 默认UTC+8 示例值：UTC+8 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | InstanceDetailVO | 调度实例详情 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例 一
获取实例详情示例
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetTaskInstance
<公共请求参数>
{
"ProjectId": "1460947878944567296",
"InstanceKey": "20250326150742906_2025-03-28 00:00:00",
"ScheduleTimeZone": "UTC+6"
}输出示例
{
"Response": {
"Data": {
"CostTime": "00:00:12.000",
"CurRunDate": "2025-03-28 00:00:00",
"EndTime": "2025-03-27 22:18:55",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 00:00:00",
"InstanceLifeCycleList": [
{
"BrokerIp": "ins-6m365yvb",
"CodeFileName": null,
"CostTime": "-11",
"ExecutionJobId": "6820250328000318055",
"InstanceKey": "20250326150742906_2025-03-28 00:00:00",
"InstanceState": 2,
"LifeCycleDetailList": [
{
"DetailState": "COMPLETE",
"EndTime": null,
"StartTime": "2025-03-27 22:18:59",
"State": null
},
{
"DetailState": "RUNNING",
"EndTime": "2025-03-27 22:18:59",
"StartTime": "2025-03-27 22:18:43",
"State": null
},
{
"DetailState": "WAIT_RUN",
"EndTime": "2025-03-27 22:18:43",
"StartTime": "2025-03-27 22:02:58",
"State": null
},
{
"DetailState": "WAIT_UPSTREAM",
"EndTime": "2025-03-27 22:02:58",
"StartTime": "2025-03-27 22:02:44",
"State": null
}
],
"LifeRoundNum": 0,
"LogType": null,
"OriginFileName": null,
"RunType": "PERIODIC",
"Tries": 0
}
],
"InstanceState": 2,
"InstanceType": null,
"LatestLog": {
"BrokerIp": "ins-6m365yvb",
"CodeFileSize": "1 KB",
"CodeInfo": "echo this is log demo;",
"EndTime": "2025-03-27 22:18:59",
"ExtInfo": "45308",
"InstanceKey": "20250326150742906_2025-03-28 00:00:00",
"InstanceState": 2,
"IsEnd": true,
"LineCount": 331,
"LogFileSize": "1 KB",
"LogInfo": "2025-03-28 00:18:37 this is log demo",
"ProjectId": "1460947878944567296",
"RunType": "PERIODIC",
"StartTime": "2025-03-27 22:18:43"
},
"NextCurDate": "2025-03-28 00:20:00",
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-27 22:00:00",
"StartTime": "2025-03-27 22:18:43",
"TaskCycleType": "I",
"TaskId": "20250326150742906",
"TaskName": "dq_test_dylan_shell_01",
"TaskType": {
"TypeDesc": "Shell",
"TypeId": 35,
"TypeSort": "数据计算"
},
"TotalRunNum": 1,
"Tries": 1,
"TryLimit": 5,
"WorkflowId": "ec66594e-53a0-48cb-8044-a9eb3a58efe5",
"WorkflowName": "dq_test_0326"
},
"RequestId": "e8393496-32f6-4273-8555-32b9a69d63cb"
}
}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 | 操作失败。 |
