调用ExecuteJob触发一次任务_分布式任务调度(SchedulerX)-阿里云帮助中心

触发一次任务立即运行。

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

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

请求参数

名称	类型	必填	描述	示例值
JobId	long	是	任务 ID，在控制台的任务管理页面中获取。	92583
InstanceParameters	string	否	本次触发携带参数，可以是任意字符串，`processor`代码通过`context.getInstanceParameters()`获取，区别于创建任务自定义参数。	test
Namespace	string	是	命名空间 ID，在控制台的命名空间页面中获取。	adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSource	string	否	特殊第三方才需要填写。	schedulerx
GroupId	string	是	应用 ID，在控制台的应用管理页面中获取。	testSchedulerx.defaultGroup
RegionId	string	是	地域 ID。	cn-hangzhou
CheckJobStatus	boolean	否	是否检查任务状态，取值如下：true：任务启用才能执行任务。false：任务不启用也可以执行任务。	true
DesignateType	integer	否	指定机器的类型，取值如下：1：指定 worker。2：指定 label	1
Worker	string	否	应用的 worker 地址，需要先通过 GetWokerList 接口返回 workerAddress	xxxxxxx@127.0.0.1:222
Label	string	否	worker 的标签	gray

返回参数

名称	类型	描述	示例值
	object
Code	integer	返回码。	200
Message	string	错误消息，仅出错时返回错误信息。	groupid not exist groupId: testSchedulerx.defaultGroup namespace: adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
RequestId	string	请求唯一 ID。	4F68ABED-AC31-4412-9297-D9A8F0401108****
Success	boolean	触发任务是否成功。取值如下： `true`：触发任务成功。 `false`：触发任务失败。	true
Data	object	如果成功，会返回任务实例 ID。
JobInstanceId	long	任务实例 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
  },
  "AccessDeniedDetail": {
    "AuthAction": "",
    "AuthPrincipalDisplayName": "",
    "AuthPrincipalOwnerId": "",
    "AuthPrincipalType": "",
    "EncodedDiagnosticMessage": "",
    "NoPermissionType": "",
    "PolicyType": ""
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-10-21	OpenAPI 返回结构发生变更	查看变更详情
2022-12-26	API 内部配置变更，不影响调用	查看变更详情
2021-12-30	OpenAPI 入参发生变更	查看变更详情
2021-12-20	OpenAPI 入参发生变更	查看变更详情