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

创建调度计划

功能介绍

创建调度计划。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/fdi/instances/{instance_id}/tasks/{task_id}/dispatches

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

最小长度：1

最大长度：64

instance_id

是

String

实例ID。

最小长度：1

最大长度：64

task_id

是

String

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

最小长度：1

最大长度：64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

start_datetime

否

Integer

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

最小值：0

最大值：99999999999999999

period

否

String

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

  • MIN (分钟)

  • HOUR (小时)

  • DAY (日)

  • WEEK (周)

  • MON (月)

最小长度：0

最大长度：36

dispatch_interval

否

Integer

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

最小值：1

最大值：59

remark

否

String

调度计划的备注信息。

最小长度：8

最大长度：36

use_quartz_cron

否

Boolean

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

  • true (使用cron表达式)

  • false (不使用cron表达式)

最小长度：4

最大长度：16

cron

否

String

调度计划的cron表达式。

最小长度：8

最大长度：255

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

dispatch_id

String

调度计划ID。

最小长度：1

最大长度：64

task_id

String

调度计划关联的任务ID。

最小长度：1

最大长度：64

start_datetime

Integer

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

最小值：0

最大值：99999999999999999

period

String

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

  • MIN (分钟)

  • HOUR (小时)

  • DAY (日)

  • WEEK (周)

  • MON (月)

最小长度：0

最大长度：36

dispatch_interval

Integer

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

最小值：1

最大值：59

created_date

Integer

调度计划的创建时间。

最小值：1

最大值：99999999999999999

last_modified_date

Integer

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

最小值：1

最大值：99999999999999999

remark

String

调度计划的备注信息。

最小长度：8

最大长度：36

use_quartz_cron

Boolean

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

  • true (使用cron表达式)

  • false (不使用cron表达式)

最小长度：4

最大长度：16

cron

String

调度计划的cron表达式。

最小长度：8

最大长度：255

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：36

error_msg

String

错误描述。

最小长度：2

最大长度：512

状态码： 404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：36

error_msg

String

错误描述。

最小长度：2

最大长度：512

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：36

error_msg

String

错误描述。

最小长度：2

最大长度：512

请求示例

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

{
  "use_quartz_cron" : false,
  "remark" : "123",
  "start_datetime" : "2020-11-14T07:38:25.609Z",
  "period" : "DAY",
  "dispatch_interval" : 1
}

响应示例

状态码： 200

OK

{
  "dispatch_id" : "a0f7fa9897da423dadbe8391d7ea7a43",
  "task_id" : "15366328208d4d77b76532fe9f4006a6",
  "start_datetime" : 1605339505609,
  "period" : "DAY",
  "dispatch_interval" : 1,
  "created_date" : 1605311230685,
  "last_modified_date" : 1605311230685,
  "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

错误码

请参见错误码。

父主题： 任务管理

相关文档