ExecuteJob_任务调度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.

接口说明

说明 因为JobID联合ScheduleTime是唯一索引,所以同一个任务连续调用 ExecuteJob 接口的时,每次要 sleep 一秒,否则任务有可能会失败。

流控信息

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

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
JobIdinteger<int64>

任务 ID,在控制台的任务管理页面中获取。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:92583参考取值来源:
    ListJobs
    CreateJob
InstanceParametersstring

本次触发携带参数,可以是任意字符串,processor代码通过context.getInstanceParameters()获取,区别于创建任务自定义参数。

示例值:test
Namespacestring

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

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

特殊第三方才需要填写。

示例值:schedulerx
GroupIdstring

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

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

地域 ID。

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

是否检查任务状态,取值如下:true:任务启用才能执行任务。false:任务不启用也可以执行任务。

示例值:true
DesignateTypeinteger<int32>

指定机器的类型,取值如下:1:指定 worker。2:指定 label

示例值:1
Workerstring

应用的 worker 地址,需要先通过 GetWokerList 接口返回 workerAddress

示例值:xxxxxxx@127.0.0.1:222参考取值来源:
    GetWorkerList
Labelstring

worker 的标签

示例值:gray

返回参数

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

返回码。

示例值:200
Messagestring

错误消息,仅出错时返回错误信息。

示例值:groupid not exist groupId: testSchedulerx.defaultGroup namespace: adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
RequestIdstring

请求唯一 ID。

示例值:4F68ABED-AC31-4412-9297-D9A8F0401108****
Successboolean

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

示例值:true
Dataobject

如果成功,会返回任务实例 ID。

返回示例

变更历史

变更时间变更内容概要操作
2024-12-20
变更返回参数
2024-10-21
变更返回参数
2022-12-26
变更请求参数RegionId
2021-12-30
新增请求参数DesignateType
新增请求参数Worker
新增请求参数Label
2021-12-20
新增请求参数CheckJobStatus

相关示例