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

查询调度计划 - ShowDispatches

功能介绍

查询调度计划。

授权信息

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。

task_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表3 响应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

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码：404

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码：500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

无

响应示例

状态码：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
}

状态码

状态码

描述

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题：任务管理