调用ExecuteJob接口触发一次任务。所有时间类型的任务, 都可以通过ExecuteJob接口来触发任务。
说明 因为
JobID
联合ScheduleTime
是唯一索引,所以同一个任务连续调用ExecuteJob接口的时,每次要sleep一秒,否则任务有可能会失败。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ExecuteJob |
系统规定参数。取值: |
JobId | Long | 是 | 92583 |
任务ID,在控制台的任务管理页面中获取。 |
InstanceParameters | String | 是 | test |
本次触发携带参数,可以是任意字符串, |
Namespace | String | 是 | adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
命名空间ID,在控制台的命名空间页面中获取。 |
NamespaceSource | String | 否 | schedulerx |
特殊第三方才需要填写。 |
GroupId | String | 是 | testSchedulerx.defaultGroup |
应用ID,在控制台的应用管理页面中获取。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | Integer | 200 |
返回码。 |
Message | String | groupid not exist groupId: testSchedulerx.defaultGroup namespace: adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
错误消息,仅出错时返回错误信息。 |
RequestId | String | 4F68ABED-AC31-4412-9297-D9A8F0401108**** |
请求唯一ID。 |
Success | Boolean | true |
触发任务是否成功。取值如下:
|
Data | Object |
如果成功,会返回任务实例ID。 |
|
JobInstanceId | Long | 11111111 |
任务实例ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ExecuteJob
&JobId=92583
&InstanceParameters=test
&Namespace=adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
&NamespaceSource=schedulerx
&GroupId=testSchedulerx.defaultGroup
&RegionId=cn-hangzhou
&CheckJobStatus=true
&DesignateType=1
&Worker=test
&Label=test
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ExecuteJobResponse>
<Code>200</Code>
<Message>groupid not exist groupId: testSchedulerx.defaultGroup namespace: adcfc35d-e2fe-4fe9-bbaa-20e90ffc****</Message>
<RequestId>4F68ABED-AC31-4412-9297-D9A8F0401108****</RequestId>
<Success>true</Success>
<Data>
<JobInstanceId>11111111</JobInstanceId>
</Data>
</ExecuteJobResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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
}
}