帮你快速理解、总结文档立即下载

更新工作流下任务调度信息

最近更新时间:2026-09-01 04:37:21
我的收藏

1. 接口描述

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

更新工作流下任务调度信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:RenewWorkflowSchedulerInfoDs。
Version 是 String 公共参数,本接口取值:2021-08-20。
Region 是 String 公共参数,详见产品支持的 地域列表。
ProjectId 是 String 项目ID
WorkflowId 是 String 工作流ID
DelayTime 否 Integer 延迟时间
StartupTime 否 Integer 启动时间
SelfDepend 否 String 任务依赖
StartTime 否 String 开始时间
EndTime 否 String 结束时间
TaskAction 否 String 指定运行时间
CycleType 否 String 调度周期时间单位
CycleStep 否 Integer 调度周期
ExecutionStartTime 否 String 执行时间左闭区间
ExecutionEndTime 否 String 执行时间右闭区间
InstanceInitStrategy 否 String 任务初始化策略,T_PLUS_1、T_PLUS_0、T_MINUS_1
DependencyWorkflow 否 String 工作流依赖,yes or no
CrontabExpression 否 String CrontabExpression
ModifyCycleValue 否 String 0:不修改
1:将任务的上游依赖配置改为默认值
示例值:0、1
CalendarOpen 否 String 是否开启日历调度 1 开启 0关闭
CalendarName 否 String 日历名称
CalendarId 否 String 日历id
ScheduleTimeZone 否 String 时区
ClearLink 否 Boolean 是否自动清理不支持的任务链接
示例值:true
MainCyclicConfig 否 String ModifyCycleValue为1的时候生效,表示默认修改的上游依赖-时间维度
示例值:HOUR
SubordinateCyclicConfig 否 String ModifyCycleValue为1的时候生效,表示默认修改的上游依赖-实例范围
示例值:CURRENT_HOUR

3. 输出参数

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

4. 示例

示例1 示例1

demo

输入示例

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

{
    "ProjectId": "1460947878944567296",
    "WorkflowId": "e5b0945c-ed6d-11ed-8909-bc97e105ba60",
    "DelayTime": 0,
    "SelfDepend": "serial",
    "StartTime": "2023-05-13 12:44:29",
    "EndTime": "2023-05-12 23:59:59",
    "TaskAction": "",
    "CycleType": "DAY_CYCLE",
    "CycleStep": 1
}

输出示例

{
    "Response": {
        "Data": {
            "Failed": 0,
            "Success": 0,
            "Total": 0
        },
        "RequestId": "59a4462b-66f3-4cc2-80a2-46c416726c46"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。