1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
更新工作流调度
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyWorkflowSchedule。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目Id 示例值：1492511691123199776 |
| WorkflowId | 是 | String | 工作流id 示例值：41fd29d-164f-11ee-8d13-a4ae120f |
| DelayTime | 是 | Integer | 延迟时间，单位分钟 示例值：0 |
| StartupTime | 是 | Integer | 启动时间 示例值：1712883299 |
| SelfDepend | 是 | Integer | 自依赖类型 1:有序串行 一次一个 排队, 2: 无序串行 一次一个 不排队， 3:并行 一次多个 示例值：2 |
| CycleType | 是 | Integer | "周期类型 0:crontab类型, 1:分钟，2:小时，3:天，4:周，5:月，6:一次性，7:用户驱动，10:弹性周期 周,11:弹性周期 月,12:年,13:即时触发Instant类型，与正常周期调度任务逻辑隔离 示例值：1 |
| CycleStep | 是 | Integer | 步长，间隔时间，最小1 示例值：10 |
| StartTime | 否 | String | 生效开始时间，格式 yyyy-MM-dd HH:mm:ss 示例值：2024-04-07 10:00:00 |
| EndTime | 否 | String | 生效结束时间，格式 yyyy-MM-dd HH:mm:ss 示例值：2024-04-13 12:00:00 |
| TaskAction | 否 | String | 调度配置-弹性周期配置，小时/周/月/年调度才有，小时任务指定每天的0点3点4点跑，则为'0,3,4'。 示例值：0 |
| CrontabExpression | 否 | String | cron表达式 周期类型为crontab调度才需要 示例值：*/10 * * * * |
| ExecutionStartTime | 否 | String | 执行时间左闭区间，格式：HH:mm 小时调度才有，例如小时任务, 每日固定区间生效 示例值：12:00 |
| ExecutionEndTime | 否 | String | 执行时间右闭区间，格式：HH:mm 小时调度才有，例如小时任务, 每日固定区间生效 示例值：23:59 |
| DependencyWorkflow | 否 | String | 工作流依赖 ,yes 或者no 示例值：no |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | BatchResult | 执行结果 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新工作流调度范例1
更新工作流调度
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyWorkflowSchedule
<公共请求参数>
{
"WorkflowId": "34e51bc4-0cd9-11ed-89e105ba60",
"StartupTime": "47483648",
"SelfDepend": "1",
"ProjectId": "1",
"ExecutionEndTime": "",
"TaskAction": "",
"DelayTime": "1",
"DependencyWorkflow": "no",
"StartTime": "2022-03-03 11:12:59",
"ExecutionStartTime": "",
"EndTime": "2022-09-03 11:12:59",
"CycleType": "1",
"CycleStep": "3",
"CrontabExpression": ""
}输出示例
{
"Response": {
"RequestId": "dc5397bb-74e6f734102c",
"Data": {
"Running": 0,
"Success": 0,
"Failed": 0,
"Total": 0
}
}
}示例2 更新工作流调度范例2
更新工作流调度
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyWorkflowSchedule
<公共请求参数>
{
"WorkflowId": "34e51bc4-0cd9-1105ba60",
"StartupTime": "47483648",
"SelfDepend": "1",
"ProjectId": "1",
"ExecutionEndTime": "",
"TaskAction": "",
"DelayTime": "1",
"DependencyWorkflow": "no",
"StartTime": "2022-03-03 11:12:59",
"ExecutionStartTime": "",
"EndTime": "2022-09-03 11:12:59",
"CycleType": "1",
"CycleStep": "3",
"CrontabExpression": ""
}输出示例
{
"Response": {
"RequestId": "c20f7fea-d73f-44cd-94a5-1d9f884df5cf",
"Data": {
"Running": 0,
"Success": 0,
"Failed": 0,
"Total": 0
}
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
