调用UpdateTaskFlowSchedule接口,更新任务流调度配置-阿里云帮助中心

该接口用于更新编辑态任务流的调度设置。可配置定时调度、周期调度、事件调度；其中定时调度可配置调度一次或周期调度，事件调度可配置的订阅包括任务流和任务流节点。

配置更新后，将任务流重新发布并部署，新的任务流实例将按照配置的调度设置进行调度。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	UpdateTaskFlowSchedule	系统规定参数。取值：UpdateTaskFlowSchedule。
Tid	Long	否	3***	租户ID。说明鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见查看租户信息。
DagId	Long	是	7***	任务流ID，任务流的唯一标识。
ScheduleSwitch	Boolean	是	关闭	是否开启调度。开启关闭
CronBeginDate	String	否	CronBeginDate_test	此时间点之前任务流不进行调度。
CronEndDate	String	否	CronEndDate_test	定时调度结束时间，此时间点之后任务流不进行调度。
ScheduleParam	String	是	ScheduleParam_test	事件调度配置，JSON字符串格式。
CronStr	String	否	CronStr_test	定时调度Cron。
TriggerType	String	是	Event	触发类型，取值如下： Cron：定时调度 Event：事件触发
CronType	String	否	HOUR	调度周期类型。取值如下： MINUTE：分钟级调度 HOUR：小时级调度 DAY：日级调度 WEEK: 周级调度 MONTH：月级调度
TimeZoneId	String	否	Asia/Shanghai	时区设置，默认为东八区（Asia/Shanghai）。

调度配置相关参数说明

配置定时调度：可配置周期调度或调度一次。

必填参数如下：

ScheduleSwitch：True
TriggerType：Cron
CronBeginDate
CronEndDate
CronStr
CronType
ScheduleParam：分为按天、周、月、调度一次。

示例如下：

按“天”调度：

json
{
    "triggerType":"0",
    "dateTime":"00:00"
}

按“周”调度：周日为1，周一为2，…，周六为7。

json
{
    "triggerType":"0",
    "dateWeek":[
        "1",
        "5"
    ],
    "weekTime":"00:00"
}

按“月”调度：

json
{
    "triggerType":"0",
    "dateMonth":"1",
    "MonthTime":"00:00"
}

调度一次：

json
{
    "triggerType":"1",
    "specificTime":"2022-09-02 00:00"
}

参数说明

1. CronStr：任务流实际调度以CronStr指定为准。

2. CronBeginDate和CronEndDate：周期调度时，CronBeginDate、CronEndDate及CronStr共同定义了任务流调度。若CronStr指定的时间点在CronBeginDate、CronEndDate的时间范围内，任务将被触发。

3. CronType：验证使用，按照CronStr定义的周期填写。

4. ScheduleParam：需按照CronStr指定的调度填写。

配置事件调度（跨任务流自动触发）

必填参数如下：

ScheduleSwitch：True
TriggerType： Event
ScheduleParam

示例如下：

json
{
    "triggerType":"2" // 事件调度时置为2
    "deps":[ // 任务流、节点订阅配置
        {
            "eventType":1, // 订阅类型: 0为任务流; 1为任务节点
            "lisDagId":12345, // 订阅节点所在的任务流
            "lisNodeId":2134 // 订阅节点的Id
        },
        {
            "eventType":0,
            "lisDagId":12343 // 订阅任务流的Id
        },
        {
            "eventType":0,
            "lisDagId":23456
        }
    ],
    "maxWait":21600 // 在所有以上订阅运行成功前，最大等待时间
}

返回数据


名称	类型	示例值	描述
RequestId	String	7BF38A13-C181-5B5E-97F1-8643F8A10093	请求ID，用于定位日志，排查问题。
ErrorCode	String	InvalidParameterValid	错误码。
ErrorMessage	String	InvalidParameterValid	调用失败时，返回的错误信息。
Success	Boolean	true	请求是否成功，返回值如下： true：请求成功 false：请求失败

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=UpdateTaskFlowSchedule
&ScheduleSwitch=false
&CronBeginDate=CronBeginDate_test
&CronEndDate=CronEndDate_test
&ScheduleParam=ScheduleParam_test
&CronStr=CronStr_test
&TriggerType=Event
&CronType=HOUR
&TimeZoneId=Asia/Shanghai
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateTaskFlowScheduleResponse>
    <RequestId>7BF38A13-C181-5B5E-97F1-8643F8A10093</RequestId>
    <ErrorCode>InvalidParameterValid</ErrorCode>
    <ErrorMessage>InvalidParameterValid</ErrorMessage>
    <Success>true</Success>
</UpdateTaskFlowScheduleResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "7BF38A13-C181-5B5E-97F1-8643F8A10093",
  "ErrorCode" : "InvalidParameterValid",
  "ErrorMessage" : "InvalidParameterValid",
  "Success" : true
}

错误码

访问错误中心查看更多错误码。