CreateJob_任务调度XXLJOB版 _API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
ClusterIdstring

集群 ID

示例值:xxljob-b6ec1xxxx
AppNamestring

应用名称

示例值:test-app
Namestring

任务名称

示例值:test-job字符长度 <= 200字符长度 >= 1
Descriptionstring

任务描述

示例值:test字符长度 <= 300
JobTypestring

任务类型

示例值:xxljob枚举值:xxljob
RouteStrategyinteger<int32>

路由策略。具体取值如下:展开详情

示例值:1取值 <= 8
Parametersstring

任务参数

示例值:test
MaxConcurrencyinteger<int32>

最大并发数

示例值:1取值 <= 200
MaxAttemptinteger<int32>

错误最大重试次数,根据业务需求填写

示例值:3
AttemptIntervalinteger<int32>

错误重试间隔,单位 s,默认值为 30。

示例值:3
JobHandlerstring

jobhandler 名称

示例值:testJobVoidHandler字符长度 <= 200字符长度 >= 1
TimeTypeinteger<int32>

时间类型:展开详情

示例值:-1枚举值:-11235100
TimeExpressionstring

时间表达式,根据选择的时间类型设置时间表达式。展开详情

示例值:0 0 4 ? * Mon/1枚举值:
Calendarstring

cron 类型可以选择填写自定义日历。

示例值:workday
Timezonestring

时区

示例值:GMT+8
StartTimeinteger<int64>

开始时间

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1701310327000
Priorityinteger<int32>

优先级:展开详情

示例值:5取值 >= 1
NoticeConfigobject

通知配置

NoticeContactsarray<object>

通知联系人配置

Statusinteger<int32>

任务状态,默认为启用状态。展开详情

示例值:1枚举值:01
ExecutorBlockStrategyinteger<int32>

客户端阻塞处理策略。展开详情

示例值:1枚举值:123

返回参数

字段名称字段详情
Codeinteger<int32>

响应码

示例值:200
Messagestring

错误信息

示例值:Parameter error: content is null.
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

示例值:3835AA29-2298-5434-BC53-9CC377CDFD2C
Successboolean

是否调用成功。展开详情

示例值:true
Dataobject

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidParameter
Parameter error: %s.诊断
401
IllegalRequest
IllegalRequest: %s.诊断
403
NoPermission
No permission to perform this operation: %s.诊断
404
NotFound
Not found: %s.诊断
500
InternalError
InternalError: %s.诊断

变更历史

变更时间变更内容概要操作
2025-01-09
变更请求参数NoticeContacts
2024-12-17
变更请求参数TimeType
新增请求参数ExecutorBlockStrategy
2024-11-26
新增OpenAPI,创建任务

相关示例

2024年08月20日