文档

ExecuteJob - 触发一次任务

更新时间:
一键部署

触发一次任务立即运行。

接口说明

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

调试

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

调试

授权信息

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

请求参数

名称类型必填描述示例值
JobIdlong

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

92583
InstanceParametersstring

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

test
Namespacestring

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

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSourcestring

特殊第三方才需要填写。

schedulerx
GroupIdstring

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

testSchedulerx.defaultGroup
RegionIdstring

地域ID。

cn-hangzhou
CheckJobStatusboolean

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

true
DesignateTypeinteger

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

1
Workerstring

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

xxxxxxx@127.0.0.1:222
Labelstring

worker的标签

gray

返回参数

名称类型描述示例值
object
Codeinteger

返回码。

200
Messagestring

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

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

请求唯一ID。

4F68ABED-AC31-4412-9297-D9A8F0401108****
Successboolean

触发任务是否成功。取值如下:

  • true:触发任务成功。
  • false:触发任务失败。
true
Dataobject

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

JobInstanceIdlong

任务实例ID。

11111111

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "groupid not exist groupId: testSchedulerx.defaultGroup namespace: adcfc35d-e2fe-4fe9-bbaa-20e90ffc****",
  "RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108****",
  "Success": true,
  "Data": {
    "JobInstanceId": 11111111
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-12-26API 内部配置变更,不影响调用
变更项变更内容
API 内部配置变更,不影响调用
2021-12-30OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:DesignateType
    新增入参:Worker
    新增入参:Label
2021-12-20OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:CheckJobStatus
  • 本页导读 (1)