CreateJob - 创建任务_分布式任务调度(SchedulerX)-阿里云帮助中心

创建任务。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID	xxljob-b6ec1xxxx
AppName	string	是	应用名称	test-app
Name	string	是	任务名称	test-job
Description	string	否	任务描述	test
JobType	string	是	任务类型	xxljob
RouteStrategy	integer	是	路由策略。具体取值如下： 1: 轮询 2: 随机 3: 第一个 4: 最后一个 5: 最不经常使用 6: 最近最久未使用 7: 一致性哈希 8: 分片广播	1
Parameters	string	否	任务参数	test
MaxConcurrency	integer	否	最大并发数	1
MaxAttempt	integer	否	错误最大重试次数，根据业务需求填写	3
AttemptInterval	integer	否	错误重试间隔，单位 s，默认值为 30。	3
JobHandler	string	是	jobhandler 名称	testJobVoidHandler
TimeType	integer	是	时间类型： -1: none 1：cron 3：fix_rate 5：one_time 100:：api	-1
TimeExpression	string	否	时间表达式，根据选择的时间类型设置时间表达式。 none：无需填写 cron：填写标准的 cron 表达式，支持在线验证。 api：无需填写 fixed_rate：填写具体固定频率值，单位 s。如 200 表示每隔 200s 触发一次。 one_time: 填写调度时间（yyyy-MM-dd HH:mm:ss）或者时间戳（毫秒），比如"2022-10-10 10:10:00"	0 0 4 ? * Mon/1
Calendar	string	否	cron 类型可以选择填写自定义日历。	workday
Timezone	string	否	时区	GMT+8
StartTime	long	否	开始时间	1701310327000
Priority	integer	否	优先级: 1: 低 5: 中 10: 高 15: 非常高	5
NoticeConfig	object	否	通知配置
TimeoutEnable	boolean	否	超时报警开关。取值如下： true：开启 false：关闭	true
Timeout	long	否	超时时间，单位秒。	30
TimeoutKillEnable	boolean	否	超时终止开关。取值如下： true：开启超时终止开关。 false：关闭超时终止开关。	true
SuccessNotice	boolean	否	成功通知开关。取值如下： true：开启。 false：关闭。	true
FailEnable	boolean	否	失败报警开关。取值如下： true：开启失败报警开关。 false：关闭失败报警开关。	true
FailLimitTimes	integer	否	连续失败次数。说明只有连续失败超过配置次数才会收到报警。	1
MissWorkerEnable	boolean	否	是否开启无可用机器报警。 true：开启无可用机器报警开关。 false：关闭无可用机器报警开关。	true
SendChannel	string	否	通知渠道,取值如下：短信：sms 电话：phone 邮件：mail webhook：webhook 说明配置多个通知渠道请用逗号分割	mail
NoticeContacts	array<object>	否	通知联系人配置
	object	否	.
ContactType	integer	否	联系人类型说明默认配置: 1	1
Name	string	否	联系人名称	xiaoming
Status	integer	否	任务状态，默认为启用状态。 0: 禁用 1: 启用	1
ExecutorBlockStrategy	integer	否	客户端阻塞处理策略。 1: 单机串行 2: 忽略后续调度 3: 覆盖之前调度	1

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Code	integer	响应码	200
Message	string	错误信息	Parameter error: content is null.
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	3835AA29-2298-5434-BC53-9CC377CDFD2C
Success	boolean	是否调用成功。 true：调用成功 false：调用失败	true
Data	object
JobId	long	任务 id	74

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "Parameter error: content is null.",
  "RequestId": "3835AA29-2298-5434-BC53-9CC377CDFD2C",
  "Success": true,
  "Data": {
    "JobId": 74
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	Parameter error: %s.	参数错误: %s
401	IllegalRequest	IllegalRequest: %s.	非法请求：%s
403	NoPermission	No permission to perform this operation: %s.	没有权限去执行该操作：%s
404	NotFound	Not found: %s.	资源不存在：%s
500	InternalError	InternalError: %s.	系统内部错误：%s

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2025-03-24	OpenAPI 入参发生变更	查看变更详情
2025-01-09	API 内部配置变更，不影响调用	查看变更详情
2024-12-17	OpenAPI 入参发生变更	查看变更详情