調用ExecuteJob接口觸發一次任務。所有時間類型的任務, 都可以通過ExecuteJob接口來觸發任務。

說明 因為JobID聯合ScheduleTime是唯一索引,所以同一個任務連續調用ExecuteJob接口的時,每次要sleep一秒,否則任務有可能會失敗。

調試

您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String ExecuteJob

系統規定參數。取值:ExecuteJob

JobId Long 92583

任務ID,在控制臺的任務管理頁面中獲取。

InstanceParameters String test

本次觸發攜帶參數,可以是任意字符串,processor代碼通過context.getInstanceParameters()獲取,區別于創建任務自定義參數。

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

觸發任務是否成功。取值如下:

  • true:觸發任務成功。
  • false:觸發任務失敗。
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
  }
}