手动任务触发运行

最近更新时间:2025-04-25 02:14:11

我的收藏

1. 接口描述

接口请求域名: wedata.tencentcloudapi.com 。

手动任务触发运行

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:TriggerManualTasks。
Version String 公共参数,本接口取值:2021-08-20。
Region String 公共参数,详见产品支持的 地域列表
ProjectId String 项目ID
示例值:1
TriggerName String 触发运行名称
示例值:task_t1
TriggerScope String 运行范围 ENTIRE_WORKFLOW or SPECIFIED_TASK
示例值:ENTIRE_WORKFLOW
DataTimeList.N Array of String 运行数据时间列表
示例值:[2024-12-12 11:11:11]
WorkflowId String 工作流ID
示例值:9256-11ed-8909-bc
Remark String 备注
示例值:备注
TaskIds.N Array of String 需要运行的任务列表
TriggerScope=ENTIRE_WORKFLOW 时无需传此参数,TriggerScope=SPECIFIED_TASK此参数必传
示例值:[20240611101643545]
SchedulerResourceGroup String 用户提交运行时指定的调度资源组,未指定时使用任务配置的调度资源组
示例值:202406111033
IntegrationResourceGroup String 用户提交运行时指定的集成资源组,未指定时使用任务配置的集成资源组
示例值:202406111044
ExecOrder String 执行顺序 ASC、RAND、DESC
示例值:ASC
CustomParams.N Array of KVPair 自定义参数,最高优先级
示例值:[{Key:name,Value:jack}]
ExtraParams String 页面反显使用,无业务含义
示例值:jsonString
ScheduleTimeZone String 实例时间的时区
示例值:UTC+8
TimeType String 时间类型,DATA_TIME:数据时间、SCHEDULE_TIME:计划调度时间, 为空时会被当成DATA_TIME处理
示例值:DATA_TIME

3. 输出参数

参数名称 类型 描述
RequestFromSource String 请求来源,WEB 前端;CLIENT 客户端
注意:此字段可能返回 null,表示取不到有效值。
Data ManualTriggerRecordOpsDto 详情结果
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 手动任务触发运行

手动任务触发运行

输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: TriggerManualTasks
<公共请求参数>

{
    "ProjectId": "1464962169590902784",
    "TriggerName": "test_name",
    "TriggerScope": "ENTIRE_WORKFLOW",
    "DataTimeList": [
        "2025-01-14 00:00:00",
        "2025-01-14 01:00:00"
    ],
    "WorkflowId": "d4d7e9a7-0649-4410-a2ae-89818043c58a",
    "Remark": "",
    "TaskIds": [],
    "SchedulerResourceGroup": "20240703113703331017",
    "IntegrationResourceGroup": "",
    "ExecOrder": "RAND",
    "CustomParams": [
        {
            "K": "param1",
            "V": "10"
        }
    ]
}

输出示例

{
    "Response": {
        "Data": {
            "CreateTime": "2025-01-14T17:42:37.069",
            "DatetimeList": [
                "2025-01-14 00:00:00",
                "2025-01-14 01:00:00"
            ],
            "FinishedInstanceCnt": null,
            "InstanceCnt": null,
            "OwnerUin": "100028448903",
            "ProjectId": "1464962169590902784",
            "Remark": "",
            "Status": "INIT",
            "SuccessInstanceCnt": null,
            "TaskCnt": null,
            "TenantId": "1315051789",
            "TriggerId": "9a350a12-40bd-4610-9d9e-445ee8730d6e",
            "TriggerName": "test_name",
            "TriggerParams": "{\"ProjectId\":\"1464962169590902784\",\"TriggerName\":\"test_name\",\"Remark\":\"\",\"TriggerScope\":\"ENTIRE_WORKFLOW\",\"WorkflowId\":\"d4d7e9a7-0649-4410-a2ae-89818043c58a\",\"TaskIds\":[\"20241223224113778\",\"20241224171752455\",\"20241223224056125\"],\"DataTimeList\":[\"2025-01-14 00:00:00\",\"2025-01-14 01:00:00\"],\"SchedulerResourceGroup\":\"20240703113703331017\",\"IntegrationResourceGroup\":\"\",\"ExecOrder\":\"RAND\",\"CustomParams\":[{\"K\":\"param1\",\"V\":\"10\"}],\"ExtraParams\":null}",
            "UserName": "wenjieyao",
            "UserUin": "100028579606"
        },
        "RequestId": "da12b6d9-fd32-4b3e-8716-5085722e06e5"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码