文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 数据集成API/ 任务管理/ 修改调度计划 - UpdateDispatches
更新时间：2025-10-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改调度计划 - UpdateDispatches

功能介绍

通过任务ID和调度ID修改调度计划。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

PUT /v2/{project_id}/fdi/instances/{instance_id}/tasks/{task_id}/dispatches/{dispatch_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

instance_id

是

String

实例ID。

task_id

是

String

任务唯一标识，任务的ID。

dispatch_id

是

String

调度唯一标识，调度计划ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

start_datetime

否

Integer

调度计划的执行开始时间，上限2147512447000，下限946684800000。

period

否

String

调度计划执行周期的时间单位，当使用cron表达式时，为空。

  • MIN (分钟)

  • HOUR (小时)

  • DAY (日)

  • WEEK (周)

  • MON (月)

dispatch_interval

否

Integer

调度计划的执行间隔时间周期。

remark

否

String

调度计划的备注信息。

use_quartz_cron

否

Boolean

调度计划是否使用cron表达式，允许如下值：

  • true (使用cron表达式)

  • false (不使用cron表达式)

cron

否

String

调度计划的cron表达式。

cron_timezone

否

String

时区信息

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

dispatch_id

String

调度计划ID。

task_id

String

调度计划关联的任务ID。

start_datetime

Integer

调度计划的执行开始时间，上限2147512447000，下限946684800000。

period

String

调度计划执行周期的时间单位，当使用cron表达式时，为空。

  • MIN (分钟)

  • HOUR (小时)

  • DAY (日)

  • WEEK (周)

  • MON (月)

dispatch_interval

Integer

调度计划的执行间隔时间周期。

created_date

Integer

调度计划的创建时间。

last_modified_date

Integer

调度计划最近一次的修改时间。

remark

String

调度计划的备注信息。

use_quartz_cron

Boolean

调度计划是否使用cron表达式，允许如下值：

  • true (使用cron表达式)

  • false (不使用cron表达式)

cron

String

调度计划的cron表达式。

cron_timezone

String

时区信息

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码：404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

修改指定数据集成任务的调度计划，不使用Cron表达式，执行间隔为每天一次

{
  "dispatch_id" : "0b046396c0f84687840c37c642389609",
  "task_id" : "34bb58f48c684b5ea1158cff69b9fbe4",
  "start_datetime" : 1605597966246,
  "period" : "DAY",
  "dispatch_interval" : 1,
  "created_date" : 1605570764692,
  "last_modified_date" : 1605570764692,
  "remark" : "123",
  "use_quartz_cron" : false
}

响应示例

状态码：200

OK

{
  "dispatch_id" : "0b046396c0f84687840c37c642389609",
  "task_id" : "34bb58f48c684b5ea1158cff69b9fbe4",
  "start_datetime" : 1605597966246,
  "period" : "DAY",
  "dispatch_interval" : 1,
  "created_date" : 1605570764692,
  "last_modified_date" : 1605570764692,
  "remark" : "123",
  "use_quartz_cron" : false
}

状态码：400

Bad Request

{
  "code" : 400,
  "reason" : {
    "error_code" : "FDI.3149",
    "error_msg" : "The task ID is empty."
  }
}

状态码：404

Not Found

{
  "code" : 404,
  "reason" : {
    "error_code" : "FDI.3180",
    "error_msg" : "This task is not in the project."
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务管理