CreateJob_任务调度SchedulerX_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请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
edas:CreateSchedulerxJobCreate
Create
全部资源
*

请求参数

字段名称字段详情
RegionIdstring

地域 ID。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
Namespacestring

命名空间 ID,在控制台的命名空间页面中获取。

示例值:adcfc35d-e2fe-4fe9-bbaa-20e90ffc****参考取值来源:
    ListNamespaces
    CreateNamespace
NamespaceSourcestring

特殊第三方才需要填写。

示例值:schedulerx
GroupIdstring

应用 ID,在控制台的应用管理页面中获取。

示例值:testSchedulerx.defaultGroup参考取值来源:
    ListGroups
    CreateAppGroup
JobTypestring

任务类型,目前支持以下几种任务类型:展开详情

示例值:java枚举值:pythonxxljobjavashellgolanggohttpdataworks参考取值来源:
    GetJobInfo
Namestring

任务名。

示例值:helloworld
Descriptionstring

任务描述。

示例值:Test
ExecuteModestring

任务执行模式,目前支持以下几种任务执行模式:展开详情

示例值:standalone枚举值:broadcastparallelgridbatchstandalonesharding
ClassNamestring

任务接口类完整路径。展开详情

示例值:com.alibaba.schedulerx.test.helloworld
Contentstring
  • 任务类型选择为 python/shell/k8s 时,填写对应的脚本内容。展开详情
示例值:echo 'hello'
Parametersstring

用户自定义参数,运行时可以获取。

示例值:test
MaxConcurrencyinteger<int32>

最大同时运行实例数量,默认值为 1,即上次触发没有运行结束,即使到了运行时刻也不会进行下次触发。

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

错误最大重试次数,根据业务需求填写,默认值为 0。

示例值:0
AttemptIntervalinteger<int32>

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

示例值:30
PageSizeinteger<int32>

并行网格任务高级配置,单次拉取子任务数,默认值为 100。

示例值:100
ConsumerSizeinteger<int32>

并行网格任务高级配置,单机单次触发执行线程数,默认值为 5。

示例值:5
QueueSizeinteger<int32>

并行网格任务高级配置,子任务队列缓存上限,默认值为 10000。

示例值:10000
DispatcherSizeinteger<int32>

并行网格任务高级配置,子任务分发线程数,默认值为 5。

示例值:5
TimeTypeinteger<int32>

时间类型,目前支持以下几种时间类型:展开详情

示例值:1枚举值:1345100
TimeExpressionstring

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

示例值:0 0/10 * * * ?
Calendarstring

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

示例值:暂不支持,不用填写
DataOffsetinteger<int32>

cron 类型可以选择时间偏移,单位 s。

示例值:2400
Timezonestring

时区

示例值:GMT+8
TimeoutEnableboolean

超时报警开关。取值如下:展开详情

示例值:false枚举值:falsetrue
Timeoutinteger<int64>

超时阈值,单位 s,默认值 7200。

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

超时终止开关。取值如下:展开详情

示例值:false枚举值:falsetrue
FailEnableboolean

失败报警开关。取值如下:展开详情

示例值:false枚举值:falsetrue
FailTimesinteger<int32>

连续失败报警次数

示例值:2
MissWorkerEnableboolean

是否开启无可用机器报警。展开详情

示例值:false
SuccessNoticeEnableboolean

成功通知开关

示例值:false
SendChannelstring

告警通知渠道。展开详情

示例值:sms枚举值:defaultwebhookmailphonesms
TaskMaxAttemptinteger<int32>

并行网格任务高级配置,子任务失败重试次数 ,默认值为 0。

示例值:0取值 <= 10
TaskAttemptIntervalinteger<int32>

并行网格任务高级配置,子任务失败重试间隔,默认值为 0。

示例值:0取值 >= 0
ContactInfoarray<object>

任务联系人信息。

子级条数 <= 10
Statusinteger<int32>

0:禁用,1:启用,默认启用。

示例值:1枚举值:01
XAttrsstring

如果是 k8s 任务类型,需要配置该参数展开详情

示例值:{"resource":"job"}枚举值:
Priorityinteger<int32>

任务优先级。取值如下:展开详情

示例值:5

返回参数

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

返回码。

示例值:200
Messagestring

附加信息。

示例值:message
RequestIdstring

请求唯一 ID。

示例值:39090022-1F3B-4797-8518-6B61095F1AF0
Successboolean

创建任务是否成功。取值如下:展开详情

示例值:true
Dataobject

任务详细信息。

返回示例

变更历史

相关示例

2024年08月20日