1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
获取实例列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ListInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目ID 示例值：1531612696090365952 |
| ScheduleTimeFrom | 是 | String | 实例计划调度时间过滤条件 过滤起始时间，时间格式为 yyyy-MM-dd HH:mm:ss 示例值：2025-03-19 00:00:00 |
| ScheduleTimeTo | 是 | String | 实例计划调度时间过滤条件 过滤截止时间，时间格式为 yyyy-MM-dd HH:mm:ss 示例值：2025-03-20 00:00:00 |
| PageNumber | 否 | Integer | 页码，整型 配合pageSize使用且不能小于1， 默认值1 示例值：1 |
| PageSize | 否 | Integer | 每页数目，整型 配合pageNumber使用且不能大于200, 默认值 10 示例值：10 |
| SortColumn | 否 | String | 查询结果排序字段 - SCHEDULE_DATE 表示 根据计划调度时间排序 - START_TIME 表示 根据实例开始执行时间排序 - END_TIME 表示 根据实例结束执行时间排序 - COST_TIME 表示 根据实例执行时长排序 示例值：SCHEDULE_DATE |
| SortType | 否 | String | 实例排序方式 - ASC - DESC 示例值：ASC |
| InstanceType | 否 | Integer | 实例类型 - 0 表示补录类型 - 1 表示周期实例 - 2 表示非周期实例 示例值：1 |
| InstanceStateList.N | 否 | Array of Integer | 实例执行状态 支持过滤多个，条件间为 或 的过滤关系 - [0] 表示 等待事件 - [12] 表示 等待上游 - [6, 7, 9, 10, 18] 表示 等待运行 - [1, 19, 22] 表示 运行中 - [21] 表示 跳过运行 - [3] 表示 失败重试 - [8, 4, 5, 13] 表示 失败 - [2] 表示 成功 示例值： [6, 7, 9, 10, 18] |
| TaskTypeIdList.N | 否 | Array of Integer | 任务类型Id - 支持过滤多个，条件间为 或 的过滤关系 - 可以通过接口 DescribeAllTaskType 获取项目支持的全部任务类型 示例值： [35] |
| TaskCycleList.N | 否 | Array of String | 任务周期类型 支持过滤多个，条件间为 或 的过滤关系 * O: ONEOFF_CYCLE * Y: YEAR_CYCLE * M: MONTH_CYCLE * W: WEEK_CYCLE * D: DAY_CYCLE * H: HOUR_CYCLE * I: MINUTE_CYCLE * C: CRONTAB_CYCLE 示例值：[H,I] |
| Keyword | 否 | String | 任务名称 或 任务ID 支持模糊搜索过滤, 多个用 英文逗号, 分割 示例值：cron_test |
| InChargeList.N | 否 | Array of String | 任务负责人 支持过滤多个，条件间为 或 的过滤关系 示例值：[gshengshi] |
| TaskFolderIdList.N | 否 | Array of String | 任务所属文件件 支持过滤多个，条件间为 或 的过滤关系 可以通过接口 FindAllFolder 获取项目下的所有文件夹列表 示例值：[bfefea67-37af***] |
| WorkflowIdList.N | 否 | Array of String | 任务所属工作流 支持过滤多个，条件间为 或 的过滤关系 可以通过接口 DescribeOpsWorkflows 获取项目下的所有工作流列表 示例值：[ba48d170-3239***] |
| ExecutorGroupIdList.N | 否 | Array of String | 执行资源组Id 支持过滤多个，条件间为 或 的过滤关系 可以通过接口 DescribeNormalSchedulerExecutorGroups 获取项目下的所有调度资源组列表 可以通过接口 DescribeNormalIntegrationExecutorGroups 获取项目下的所有集成资源组列表 示例值：[2024082115***] |
| StartTimeFrom | 否 | String | 实例执行开始时间过滤条件 过滤起始时间，时间格式为 yyyy-MM-dd HH:mm:ss 示例值：2025-03-19 00:00:00 |
| StartTimeTo | 否 | String | 实例执行开始时间过滤条件 过滤截止时间，时间格式为 yyyy-MM-dd HH:mm:ss 示例值：2025-03-20 00:00:00 |
| ScheduleTimeZone | 否 | String | 时区 timeZone, 默认UTC+8 示例值：UTC+8 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | InstancePageVO | 实例结果集 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例 一
查询实例列表示例
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListInstances
<公共请求参数>
{
"ProjectId": "1460947878944567296",
"ScheduleTimeFrom": "2025-03-28 00:00:00",
"ScheduleTimeTo": "2025-03-28 23:59:59",
"PageNumber": 1,
"PageSize": 10,
"SortColumn": "START_TIME",
"SortType": "ASC",
"InstanceType": 1,
"InstanceStateList": [
2,
8
],
"TaskTypeIdList": [
35
],
"TaskCycleList": [
"D",
"H",
"I"
],
"Keyword": "dq_test_dylan_shell_01,封禁跨时区依赖1_UTC_PLUS_8",
"InChargeList": [
"dylandlwu",
"hongdianlin"
],
"TaskFolderIdList": [
"2493fc25-643d-11ef-8ec8-b8599f277de5",
"d56ffd9e-e916-11ef-8ec8-b8599f277de5"
],
"WorkflowIdList": [
"14f315e6-4994-41dd-8a55-529c3bfa01cd",
"ec66594e-53a0-48cb-8044-a9eb3a58efe5"
],
"ExecutorGroupIdList": [
"20240222212719833743"
],
"StartTimeFrom": "2025-03-27 00:00:00",
"StartTimeTo": "2025-03-28 23:59:59",
"ScheduleTimeZone": "UTC+8"
}输出示例
{
"Response": {
"Data": {
"Items": [
{
"CostTime": "00:00:12.000",
"CurRunDate": "2025-03-28 00:00:00",
"EndTime": "2025-03-28 00: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",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 00:00:00",
"StartTime": "2025-03-28 00: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"
},
{
"CostTime": "00:00:23.000",
"CurRunDate": "2025-03-28 00:20:00",
"EndTime": "2025-03-28 00:21:09",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 00:20:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 00:20:00",
"StartTime": "2025-03-28 00:20:46",
"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"
},
{
"CostTime": "00:00:09.000",
"CurRunDate": "2025-03-28 00:40:00",
"EndTime": "2025-03-28 00:40:30",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 00:40:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 00:40:00",
"StartTime": "2025-03-28 00:40:21",
"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"
},
{
"CostTime": "00:00:09.000",
"CurRunDate": "2025-03-28 01:00:00",
"EndTime": "2025-03-28 01:12:16",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 01:00:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 01:00:00",
"StartTime": "2025-03-28 01:12:07",
"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"
},
{
"CostTime": "00:00:10.000",
"CurRunDate": "2025-03-28 01:20:00",
"EndTime": "2025-03-28 01:20:21",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 01:20:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 01:20:00",
"StartTime": "2025-03-28 01:20:11",
"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"
},
{
"CostTime": "00:00:08.000",
"CurRunDate": "2025-03-28 01:40:00",
"EndTime": "2025-03-28 01:40:27",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 01:40:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 01:40:00",
"StartTime": "2025-03-28 01:40:19",
"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"
},
{
"CostTime": "00:00:08.000",
"CurRunDate": "2025-03-28 02:00:00",
"EndTime": "2025-03-28 02:00:34",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 02:00:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 02:00:00",
"StartTime": "2025-03-28 02:00:26",
"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"
},
{
"CostTime": "00:00:10.000",
"CurRunDate": "2025-03-28 02:20:00",
"EndTime": "2025-03-28 02:20:22",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 02:20:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 02:20:00",
"StartTime": "2025-03-28 02:20:12",
"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"
},
{
"CostTime": "00:00:14.000",
"CurRunDate": "2025-03-28 02:40:00",
"EndTime": "2025-03-28 02:40:31",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 02:40:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 02:40:00",
"StartTime": "2025-03-28 02:40:17",
"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"
},
{
"CostTime": "00:00:10.000",
"CurRunDate": "2025-03-28 03:00:00",
"EndTime": "2025-03-28 03:00:30",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 03:00:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 03:00:00",
"StartTime": "2025-03-28 03:00:20",
"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"
}
],
"PageCount": 10,
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 34,
"TotalPage": 4
},
"RequestId": "39304e20-9974-4c65-844f-e31357386eba"
}
}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 | 操作失败。 |
