调用UpdateTaskFlowSchedule接口,更新任务流调度配置。
接口说明
该接口用于更新编辑态任务流的调度设置。可配置定时调度、周期调度、事件调度;其中定时调度可配置调度一次或周期调度,事件调度可配置的订阅包括任务流和任务流节点。
配置更新后,将任务流重新发布并部署,新的任务流实例将按照配置的调度设置进行调度。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dms:UpdateTaskFlowSchedule |
update |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Tid |
integer |
否 |
租户 ID。 说明
鼠标移动到界面右上角的头像处,查看租户 ID。具体操作,请参见查看租户信息。 |
3*** |
| DagId |
integer |
是 |
任务流 ID,任务流的唯一标识。 |
7*** |
| ScheduleSwitch |
boolean |
是 |
是否开启调度。
|
false |
| CronBeginDate |
string |
否 |
此时间点之前任务流不进行调度。 |
CronBeginDate_test |
| CronEndDate |
string |
否 |
定时调度结束时间,此时间点之后任务流不进行调度。 |
CronEndDate_test |
| ScheduleParam |
string |
是 |
事件调度配置,JSON 字符串格式。 |
ScheduleParam_test |
| CronStr |
string |
否 |
定时调度 Cron。 |
CronStr_test |
| TriggerType |
string |
是 |
触发类型,取值如下:
|
Event |
| CronType |
string |
否 |
调度周期类型。取值如下:
|
HOUR |
| TimeZoneId |
string |
否 |
时区设置,默认为东八区(Asia/Shanghai)。 |
Asia/Shanghai |
调度配置相关参数说明
配置定时调度:可配置周期调度或调度一次。
必填参数如下:
ScheduleSwitch:True
TriggerType:Cron
CronBeginDate
CronEndDate
CronStr
CronType
ScheduleParam:分为按天、周、月、调度一次。
示例如下:
按“天”调度:
{
"triggerType":"0",
"dateTime":"00:00"
}
按“周”调度:周日为 1,周一为 2,…,周六为 7。
{
"triggerType":"0",
"dateWeek":[
"1",
"5"
],
"weekTime":"00:00"
}
按“月”调度:
{
"triggerType":"0",
"dateMonth":"1",
"MonthTime":"00:00"
}
调度一次:
{
"triggerType":"1",
"specificTime":"2022-09-02 00:00"
}
参数说明
CronStr:任务流实际调度以 CronStr 指定为准。
CronBeginDate 和 CronEndDate:周期调度时,CronBeginDate、CronEndDate 及 CronStr 共同定义了任务流调度。若 CronStr 指定的时间点在 CronBeginDate、CronEndDate 的时间范围内,任务将被触发。
CronType:验证使用,按照 CronStr 定义的周期填写。
ScheduleParam:需按照 CronStr 指定的调度填写。
配置事件调度(跨任务流自动触发)
必填参数如下:
ScheduleSwitch:True
TriggerType: Event
ScheduleParam
示例如下:
{
"triggerType":"2" // 事件调度时置为 2
"deps":[ // 任务流、节点订阅配置
{
"eventType":1, // 订阅类型: 0 为任务流; 1 为任务节点
"lisDagId":12345, // 订阅节点所在的任务流
"lisNodeId":2134 // 订阅节点的 Id
},
{
"eventType":0,
"lisDagId":12343 // 订阅任务流的 Id
},
{
"eventType":0,
"lisDagId":23456
}
],
"maxWait":21600 // 在所有以上订阅运行成功前,最大等待时间
}
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数详情如下。 |
||
| RequestId |
string |
请求 ID,用于定位日志,排查问题。 |
7BF38A13-C181-5B5E-97F1-8643F8A10093 |
| ErrorCode |
string |
错误码。 |
InvalidParameterValid |
| ErrorMessage |
string |
调用失败时,返回的错误信息。 |
InvalidParameterValid |
| Success |
boolean |
请求是否成功,返回值如下:
|
true |
示例
正常返回示例
JSON格式
{
"RequestId": "7BF38A13-C181-5B5E-97F1-8643F8A10093",
"ErrorCode": "InvalidParameterValid",
"ErrorMessage": "InvalidParameterValid",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。