UpdateTaskFlowSchedule_数据管理_API文档-阿里云OpenAPI开发者门户

接口说明

该接口用于更新编辑态任务流的调度设置。可配置定时调度、周期调度、事件调度；其中定时调度可配置调度一次或周期调度，事件调度可配置的订阅包括任务流和任务流节点。
配置更新后，将任务流重新发布并部署，新的任务流实例将按照配置的调度设置进行调度。

流控信息

请求速率为100/1(s)。更多流控信息，请前往配额中心查看

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

dms:UpdateTaskFlowSchedule	Update	全部资源 *	无	无

请求参数

字段名称	字段详情
Tidinteger<int64>	租户 ID。展开详情注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:3***取值 <= 9223372036854775807
DagIdinteger<int64>	任务流 ID，任务流的唯一标识。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:7***
ScheduleSwitchboolean	是否开启调度。展开详情示例值:false
CronBeginDatestring	此时间点之前任务流不进行调度。示例值:CronBeginDate_test
CronEndDatestring	定时调度结束时间，此时间点之后任务流不进行调度。示例值:CronEndDate_test
ScheduleParamstring	事件调度配置，JSON 字符串格式。示例值:ScheduleParam_test
CronStrstring	定时调度 Cron。示例值:CronStr_test参考取值来源: GetDataCronClearConfig
TriggerTypestring	触发类型，取值如下：展开详情示例值:Event
CronTypestring	调度周期类型。取值如下：展开详情示例值:HOUR
TimeZoneIdstring	时区设置，默认为东八区（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 // 在所有以上订阅运行成功前，最大等待时间
}

返回参数

字段名称	字段详情
RequestIdstring	请求 ID，用于定位日志，排查问题。示例值:7BF38A13-C181-5B5E-97F1-8643F8A10093
ErrorCodestring	错误码。示例值:InvalidParameterValid
ErrorMessagestring	调用失败时，返回的错误信息。示例值:InvalidParameterValid
Successboolean	请求是否成功，返回值如下：展开详情示例值:true

返回示例

变更历史

暂无变更历史