全部产品
云市场

API 列表

更新时间:2019-06-13 14:16:47

API 列表

API 描述
CreateJobRequest 创建 Java 类型的任务。
GetJobInfoRequest 获取通过 jobID 指定的任务详情,通常用来更新任务使用。
UpdateJobRequest 更新任务部分配置信息,默认先调用获取任务找到对应字段进行修改。
DeleteJobRequest 删除指定任务。
EnableJobRequest 启用指定任务,任务创建完成以后默认启用,所以该功能配合停用任务使用。
DisableJobRequest 停用指定任务,停用后该任务将不被触发。
ExecuteJobRequest 触发一次任务。API 类型任务触发需要调用方法,非 API 类型也可以调用。
StopInstanceRequest 终止某次正在运行的实例。
GetJobInstanceListRequest 获取指定任务 ID 的执行实例列表。
GetJobInstanceRequest 获取指定实例详情。
ExecuteWorkflowRequest 触发一次工作流。
EnableWorkflowRequest 启用指定工作流。
DisableWorkflowRequest 禁用指定工作流。
DeleteWorkflowRequest 删除指定工作流。

CreateJobRequest

功能

创建 Java 类型的任务。

请求 URL

/openapi/v1/job/create

请求参数

名称 类型 必填 默认值 说明
namespace String 命名空间 ID,在控制台命名空间页面中获取。
namespaceSource String 特殊第三方才需要填写
groupId String Group ID,在分布式任务调度 2.0 的应用管理页面中获取。
jobType String 目前支持以下几种类型任务:java、python、shell、go,根据业务需求填写对应类型全部小写。
className String 如果是 java 类型任务该字段必填,需要填写任务接口类完整路径,如 com.alibaba.test.TestJob
jarUrl String 上传到 OSS 的完整路径。如果选择 JAR 包运行可以将相应 JAR 包上传到 OSS 的该路径下。
content String 任务类型为 python、shell、go 的必填脚本代码内容
name String 任务名
description String 任务描述
executeMode String 填写值从下列选择:
单机运行:standalone
广播运行:broadcatst
并行计算:parallel
内存网格:grid
网格计算:batch
parameters String 用户自定义参数,运行时可以获取
maxConcurrency int 1 最大同时运行实例数量,默认 1 即上次触发没有运行结束,不会进行下次触发即使到了运行时刻。
maxAttempt int 0 错误最大重试次数,根据业务需求填写默认为 0。
attemptInterval int 30 错误重试间隔,单位 s,默认 30s。
timeType int 时间配置类型可选如下:
cron:1
fix_rate(固定频率):3
second_delay(秒级): 4
api:100
timeExpression String API 类型:不填
fix_rate类型:填写具体固定频率值,单位 s。如 30 表示每隔 30s 触发一次。
cron 类型:填写标准的cron 表达式后台会有校验。
second_delay类型:填写固定延迟多少秒执行一次(1-60 可选)。
calendar String cron 类型可以选择填写自定义日历。
dataOffset int cron 类型可以选择时间偏移,单位 s。
pageSize int 100 并行网格任务高级配置,单次拉取子任务数。
consumerSize int 5 并行网格任务高级配置,单机单次触发执行线程数。
queueSize int 10000 并行网格任务高级配置,子任务队列缓存上限。
dispatcherSize int 5 并行网格任务高级配置,子任务分发线程数。
taskMaxAttempt int 0 并行网格任务高级配置,子任务失败重试次数 。
taskAttemptInterval int 0 并行网格任务高级配置,子任务失败重试间隔
timeoutEnable boolean false 超时报警开关默认关闭
timeout long 7200 超时阈值,单位 s。
timeoutKillEnable boolean false 超时终止本次触发开关。
failEnable boolean false 失败报警开关。
sendChannel String sms 报警发送形式可选以下(默认短信发送):
sms:短信
目前只支持短信
contactInfo List 报警联系人

ContactInfo

报警联系人配置

名称 类型 必填 默认值 说明
userPhone String 报警接收手机号
userName String 报警联系人姓名

返回参数

名称 类型 说明
code int 返回码
success boolean 是否成功
message String 错误消息
requestId String 请求唯一 ID
data Long 创建成功返回任务 ID

GetJobInfoRequest

功能

获取通过 jobID 指定的任务详情,通常用来更新任务使用。

请求 URL

/openapi/job/v1/get

请求参数

名称 类型 必填 默认值 说明
jobId long 任务id
namespace String 命名空间 ID,在控制台命名空间页面中获取。
namespaceSource String 特殊第三方才需要填写
groupId String Group ID,在分布式任务调度 2.0 的应用管理页面中获取。

返回参数

名称 类型 说明
code int 返回码
success boolean 是否成功
message String 错误消息
requestId String 请求唯一 ID
data JobConfigInfo 指定任务信息

JobConfigInfo

任务信息(GetJobInfoResponse 内对象)

名称 类型 说明
className String 任务接口类完整路径,如 com.alibaba.test.TestJob
jarUrl String 上传到 OSS 的完整路径
content String 脚本类型任务,具体执行代码
name String 任务名
description String 任务描述
status int 1:启用(可以被正常触发)
0:禁用(不会被触发)
executeMode String 填写值从下列选择:
单机运行:standalone
广播运行:broadcatst
并行计算:parallel
内存网格:grid
网格计算:batch
parameters String 用户自定义参数,运行时可以获取。
maxConcurrency int 最大同时运行实例数量,默认 1 即上次触发没有运行结束,不会进行下次触发即使到了运行时刻。
maxAttempt int 错误最大重试次数,根据业务需求填写,默认为 0。
attemptInterval int 错误重试间隔时间,单位 s,默认 30s。
mapTaskXAttrs MapTaskXAttrs 高级配置,仅限于并行计算、内存网格和网格计算使用。
timeConfig TimeConfig 时间配置参数,具体见定义。
jobMonitorInfo JobMonitorInfo 监控报警配置,具体见定义。

MapTaskXAttrs

并行、网格执行模式高级配置

名称 类型 说明
pageSize int 并行任务单词拉取子任务数,默认 100。
consumerSize int 单机单词触发执行线程数,默认 5。
queueSize int 子任务队列缓存上限,默认 10000。
dispatcherSize int 子任务分发线程数,默认 5。
taskMaxAttempt int 子任务失败重试次数
taskAttemptInterval int 子任务失败重试间隔

TimeConfig

时间配置

名称 类型 说明
timeType int 时间配置类型。可选如下:
cron:1
fix_rate(固定频率):3
second_delay(秒级): 4
api:100
timeExpression String api 类型:不填
fix_rate 类型:填写具体固定频率值,单位 s,如 30 表示每隔 30s 触发一次)
cron 类型:填写标准的 cron 表达式后台会有校验
calendar String cron 类型可以选择填写自定义日历。
dataOffset int cron 类型可以选择时间偏移,单位 s。

JobMonitorInfo

监控配置

名称 类型 说明
monitorConfig MonitorConfig 具体报警开关以及阈值配置
contactInfo List 报警联系人,不填写则会发送给分组有权限的所有人。

MonitorConfig

报警开关以及阀值配置

名称 类型 说明
timeoutEnable boolean 超时报警开关,默认关闭。
timeout long 超时阀值,单位 s,默认7200 s。
timeoutKillEnable boolean 超时终止本次触发开关,默认关闭。
failEnable boolean 失败报警开关,默认关闭。
sendChannel String 报警发送形式,可选 sms(短信)

ContactInfo

报警联系人配置

名称 类型 说明
userPhone String 用户手机号
userName String 用户名称

UpdateJobRequest

功能

更新任务部分配置信息,默认先调用获取任务找到对应字段进行修改。

请求 URL

/openapi/v1/job/update

请求参数

名称 类型 必填 默认值 说明
namespace String 命名空间 ID,在控制台命名空间页面中获取。
namespaceSource String 特殊第三方才需要填写
groupId String Group ID,在分布式任务调度 2.0 的应用管理页面中获取。
className String 如果是 Java 类型任务该字段必填,需要填写任务接口类完整路径,如 com.alibaba.test.TestJob
jarUrl String 上传到 OSS 的完整路径。如果选择 JAR 包运行可以将相应 JAR 包上传到 OSS 的该路径下。
content String 任务类型为 Python、Shell、Go 的代码脚本内容。
name String 任务名
description String 任务描述
executeMode String 填写值从下列选择:
单机运行:standalone
广播运行:broadcatst
并行计算:parallel
内存网格:grid
网格计算:batch
parameters String 用户自定义参数,运行时可以获取。
maxConcurrency int 1 最大同时运行实例数量,默认 1 即上次触发没有运行结束,不会进行下次触发即使到了运行时刻。
maxAttempt int 0 错误最大重试次数,根据业务需求填写。
attemptInterval int 30 错误重试间隔时间,单位 s。
timeType int 时间配置类型可选如下:
cron:1
fix_rate(固定频率):3
second_delay(秒级): 4
api:100
timeExpression String api 类型:不填
fix_rate 类型:填写具体固定频率值,单位 s,如 30 表示每隔 30s 触发一次)
cron 类型:填写标准的 cron 表达式后台会有校验
second_delay 类型:填写固定延迟多少秒执行一次(1~60可选)
calendar String cron 类型可以选择填写自定义日历。
dataOffset int cron 类型可以选择时间偏移,单位 s。
pageSize int 100 并行网格任务高级配置,单次拉取子任务数。
consumerSize int 5 并行网格任务高级配置,单机单次触发执行线程数。
queueSize int 10000 并行网格任务高级配置,子任务队列缓存上限。
dispatcherSize int 5 并行网格任务高级配置,子任务分发线程数。
taskMaxAttempt int 0 并行网格任务高级配置,子任务失败重试次数。
taskAttemptInterval int 0 并行网格任务高级配置,子任务失败重试间隔。
timeoutEnable boolean false 超时报警开关。
timeout long 7200 超时阀值,单位 s。
timeoutKillEnable boolean false 超时终止本次触发开关。
failEnable boolean false 失败报警开关。
sendChannel String sms 报警发送形式,目前只支持短信(sms)。
contactInfo List 报警联系人

ContactInfo

报警联系人配置

名称 类型 必填 默认值 说明
userPhone String 报警接收手机号
userName String 报警联系人姓名

返回参数

名称 类型 说明
code int 返回码
success boolean 是否成功
message String 错误消息
requestId String 请求唯一 ID

DeleteJobRequest

功能

删除指定任务。

请求 URL

/openapi/v1/job/delete

请求参数

名称 类型 必填 默认值 说明
jobId long 任务 ID
namespace String 命名空间 ID,在控制台命名空间页面中获取。
namespaceSource String 特殊第三方才需要填写
groupId String 分组 ID,在分布式任务调度 2.0 的应用管理页面中获取。

返回参数

名称 类型 说明
code int 返回码
success boolean 是否成功
message String 错误消息
requestId String 请求唯一 ID

EnableJobRequest

功能

启用指定任务。任务创建完成以后默认启用,所以该功能是在停用任务后使用。

请求 URL

/openapi/v1/job/enable

请求参数

名称 类型 必填 默认值 说明
jobId long 任务id
namespace String 命名空间 ID,在控制台命名空间页面中获取。
namespaceSource String 特殊第三方才需要填写
groupId String Group ID,在分布式任务调度 2.0 的应用管理页面中获取。

返回参数

名称 类型 说明
code int 返回码
success boolean 是否成功
message String 错误消息
requestId String 请求唯一 ID

DisableJobRequest

功能

停用指定任务。停用后该任务将不被触发。

请求 URL

/openapi/v1/job/disable

请求参数

名称 类型 必填 默认值 说明
jobId long 任务id
namespace String 命名空间 ID,在控制台命名空间页面中获取。
namespaceSource String 特殊第三方才需要填写
groupId String Group ID,在分布式任务调度 2.0 的应用管理页面中获取。

返回参数

名称 类型 说明
code int 返回码
success boolean 是否成功
message String 错误消息
requestId String 请求唯一 ID

ExecuteJobRequest

功能

触发一次任务。API 类型任务触发需要调用方法,非 API 类型也可以调用。

请求 URL

/openapi/v1/job/execute

请求参数

名称 类型 必填 默认值 说明
jobId long 任务 ID
instanceParameters String 本次触发携带参数,可以是任意字符串,processor 代码通过context.getInstanceParameters()获取,区别于任务创建自定义参数 。
namespace String 命名空间 ID,在控制台命名空间页面中获取。
namespaceSource String 特殊第三方才需要填写
groupId String Group ID,在分布式任务调度 2.0 的应用管理页面中获取。

返回参数

名称 类型 说明
code int 返回码
success boolean 是否成功
message String 错误消息
requestId String 请求唯一 ID
data Long 成功返回 instanceId

StopInstanceRequest

功能

终止某次正在运行的实例。

请求 URL

/openapi/v1/instance/kill

请求参数

名称 类型 必填 默认值 说明
instanceId long 运行实例 ID
jobId long 任务 ID
namespace String 命名空间 ID,在控制台命名空间页面中获取。
namespaceSource String 特殊第三方才需要填写
groupId String Group ID,在分布式任务调度 2.0 的应用管理页面中获取。

返回参数

名称 类型 说明
code int 返回码
success boolean 是否成功
message String 错误消息
requestId String 请求唯一 ID

GetJobInstanceListRequest

功能

获取指定任务 ID 的执行实例列表。该接口只返回最近 10 条运行实例列表。

请求 URL

/openapi/v1/instance/getList

请求参数

名称 类型 必填 默认值 说明
jobId long 任务 ID

返回参数

名称 类型 说明
code int 返回码
success boolean 是否成功
message String 错误消息
requestId String 请求唯一 ID
data List instance 列表

JobInstanceDetail

属性 类型 说明
instanceId long instanceId
jobId long jobId
status int 1:等待 3:运行中 4:成功
5:失败 9:拒绝
对应枚举类:
com.alibaba.schedulerx.common.domain.InstanceStatus
startDate String 任务执行开始时间
endDate String 任务执行结束时间
scheduleDate String 任务调度时间
dataDate String 数据时间
executor String 执行人
workAddr String 被触发客户端ip:port
result String 实例执行结果
progress String 实例进度详情
timeType int 实例调度时间类型
对应枚举类:
com.alibaba.schedulerx.common.domain.TimeType
cron:1
fix_rate(固定频率):3
second_delay(秒级): 4
api:100
triggerType int 触发类型
对应枚举类:
com.alibaba.schedulerx.common.domain.TriggerType
1: 定时调度正常触发
2:数据重刷
3:api触发
4:用户手动点击重跑
5:系统重试,系统异常,如 DB 异常

GetJobInstanceRequest

功能

获取指定实例详情

请求 URL

/openapi/v1/instance/get

请求参数

名称 类型 必填 默认值 说明
jobId long 任务 ID
jobInstanceId long 实例 ID
namespace String 命名空间 ID,在控制台命名空间页面中获取。
namespaceSource String 特殊第三方才需要填写
groupId String Group ID,在分布式任务调度 2.0 的应用管理页面中获取。

返回参数

名称 类型 说明
code int 返回码
success boolean 是否成功
message String 错误消息
requestId String 请求唯一 ID
data JobInstanceDetail instance 信息

JobInstanceDetail

属性 类型 说明
instanceId long instanceId
jobId long jobId
status int 1:等待 3:运行中 4:成功
5:失败 9:拒绝
对应枚举类:
com.alibaba.schedulerx.common.domain.InstanceStatus
startDate String 任务执行开始时间
endDate String 任务执行结束时间
scheduleDate String 任务调度时间
dataDate String 数据时间
executor String 执行人
workAddr String 被触发客户端 ip:port
result String 实例执行结果
progress String 实例进度详情
timeType int 实例调度时间类型
对应枚举类:
com.alibaba.schedulerx.common.domain.TimeType
cron:1
fix_rate(固定频率):3
second_delay(秒级): 4
api:100
triggerType int 触发类型
对应枚举类:
com.alibaba.schedulerx.common.domain.TriggerType
1: 定时调度正常触发
2:数据重刷
3:api触发
4:用户手动点击重跑
5:系统重试,系统异常,如 DB 异常。

ExecuteWorkflowRequest

功能

触发一次工作流,API 类型工作流触发需要调用方法,非 API 类型也可以调用。

请求 URL

/openapi/v1/workflow/execute

请求参数

名称 类型 必填 默认值 说明
workflowId long 工作流 ID
instanceParameters String 工作流实例动态参数,不超过 1000 字节。
namespace String 命名空间 ID,在控制台命名空间页面中获取。
namespaceSource String 特殊第三方才需要填写
groupId String Group ID,在分布式任务调度 2.0 的应用管理页面中获取。

返回参数

名称 类型 说明
code int 返回码
success boolean 是否成功
message String 错误消息
requestId String 请求唯一 ID
data Long 成功返回 wfInstanceId

EnableWorkflowRequest

功能

启用指定工作流。

请求 URL

/openapi/v1/workflow/enable

请求参数

名称 类型 必填 默认值 说明
workflowId long 工作流 ID
namespace String 命名空间 ID,在控制台命名空间页面中获取。
namespaceSource String 特殊第三方才需要填写
groupId String Group ID,在分布式任务调度 2.0 的应用管理页面中获取。

返回参数

名称 类型 说明
code int 返回码
success boolean 是否成功
message String 错误消息
requestId String 请求唯一 ID

DisableWorkflowRequest

功能

禁用指定工作流。

请求 URL

/openapi/v1/workflow/disable

请求参数

名称 类型 必填 默认值 说明
workflowId long 工作流 ID
namespace String 命名空间 ID,在控制台命名空间页面中获取。
namespaceSource String 特殊第三方才需要填写
groupId String Group ID,在分布式任务调度 2.0 的应用管理页面中获取。

返回参数

名称 类型 说明
code int 返回码
success boolean 是否成功
message String 错误消息
requestId String 请求唯一 ID

DeleteWorkflowRequest

功能

删除指定工作流。

请求 URL

/openapi/v1/workflow/delete

请求参数

名称 类型 必填 默认值 说明
workflowId long 工作流 ID
namespace String 命名空间 ID,在控制台命名空间页面中获取。
namespaceSource String 特殊第三方才需要填写
groupId String Group ID,在分布式任务调度 2.0 的应用管理页面中获取。

返回参数

名称 类型 说明
code int 返回码
success boolean 是否成功
message String 错误消息
requestId String 请求唯一 ID