1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
获取实例列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ListTaskInstances。 |
Version | 是 | String | 公共参数,本接口取值:2025-08-06。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProjectId | 是 | String | 项目ID 示例值:1531612696090365952 |
PageNumber | 否 | Integer | 页码,整型 配合pageSize使用且不能小于1, 默认值1 示例值:1 |
PageSize | 否 | Integer | **每页显示的条数,默认为10,最小值为1、最大值为100 示例值:10 |
Keyword | 否 | String | 任务名称 或 任务ID 支持模糊搜索过滤, 多个用 英文逗号, 分割 示例值:cron_test |
TimeZone | 否 | String | 时区timeZone, 传入的时间字符串的所在时区,默认UTC+8 示例值:UTC+8 |
InstanceType | 否 | Integer | 实例类型 - 0 表示补录类型 - 1 表示周期实例 - 2 表示非周期实例 示例值:1 |
InstanceState | 否 | String | 实例状态 - WAIT_EVENT: 等待事件 - WAIT_UPSTREAM: 等待上游 - WAIT_RUN: 等待运行 - RUNNING: 运行中 - SKIP_RUNNING: 跳过运行 - FAILED_RETRY: 失败重试 - EXPIRED: 失败 - COMPLETED: 成功 示例值:0 |
TaskTypeId | 否 | Integer | 任务类型Id 示例值:35 |
CycleType | 否 | String | 任务周期类型 * ONEOFF_CYCLE: 一次性 * YEAR_CYCLE: 年 * MONTH_CYCLE: 月 * WEEK_CYCLE: 周 * DAY_CYCLE: 天 * HOUR_CYCLE: 小时 * MINUTE_CYCLE: 分钟 * CRONTAB_CYCLE: crontab表达式类型 示例值:MONTH_CYCLE |
OwnerUin | 否 | String | 任务负责人id 示例值:100039183322 |
FolderId | 否 | String | 任务所属文件id 示例值:a1eb11e9-6f1a-11ed-1224-bc97e105ba60 |
WorkflowId | 否 | String | 任务所属工作流id 示例值:1f0911b9-032e-4e4f-a564-69e4b871d7e2 |
ExecutorGroupId | 否 | String | 执行资源组Id 示例值:20200222212719833743 |
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 |
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 |
LastUpdateTimeFrom | 否 | String | 实例最近更新时间过滤条件 过滤截止时间,时间格式为 yyyy-MM-dd HH:mm:ss 示例值:2025-03-19 00:00:00 |
LastUpdateTimeTo | 否 | String | 实例最近更新时间过滤条件 过滤截止时间,时间格式为 yyyy-MM-dd HH:mm:ss 示例值:2025-03-20 00:00:00 |
SortColumn | 否 | String | 查询结果排序字段- SCHEDULE_DATE 表示 根据计划调度时间排序- START_TIME 表示 根据实例开始执行时间排序- END_TIME 表示 根据实例结束执行时间排序- COST_TIME 表示 根据实例执行时长排序 示例值:SCHEDULE_DATE |
SortType | 否 | String | 实例排序方式 - ASC - DESC 示例值:ASC |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | TaskInstancePage | 实例结果集 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取任务实例列表
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListTaskInstances
<公共请求参数>
{
"ProjectId": "1460947878944567296",
"PageSize": 1,
"TimeZone": "UTC+6"
}
输出示例
{
"Response": {
"Data": {
"Items": [
{
"CostTime": 3000,
"CurRunDate": "2025-10-01 00:00:00",
"CycleType": "MONTH_CYCLE",
"EndTime": "2025-08-27 20:24:40",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "a1eb11e9-6f1a-11ed-8909-bc97e105ba60",
"FolderName": "u9ed8u8ba4u6587u4ef6u5939",
"InstanceKey": "20250714200130106_2025-10-01 00:00:00",
"InstanceState": "COMPLETED",
"InstanceType": 0,
"LastUpdateTime": "2025-08-27 20:24:44",
"OwnerUinList": [
"100039182306"
],
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-09-30 22:00:00",
"StartTime": "2025-08-27 20:24:37",
"TaskId": "20250714200130106",
"TaskName": "u8c03u5ea6u53c2u6570u6d4bu8bd51",
"TaskType": "Shell",
"TaskTypeId": 35,
"TotalRunNum": 10,
"Tries": 1,
"TryLimit": 5,
"WorkflowId": "1f0911b9-032e-4e4f-a564-69e4b871d7e2",
"WorkflowName": "u8c03u5ea6u53c2u6570u6d4bu8bd5"
}
],
"PageNumber": 1,
"PageSize": 1,
"TotalCount": 176022,
"TotalPageNumber": 176022
},
"RequestId": "93e9be2a-c5bb-4b2c-b04f-8ca64aa5a5c5"
}
}
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 | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
MissingParameter | 缺少参数错误。 |