更新任務信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClusterId | string | 是 | 集群 ID | xxljob-b6ec1xxxx |
AppName | string | 是 | 應用名稱 | test-app |
JobId | long | 是 | 任務 ID | 74 |
Name | string | 否 | 任務名稱 | test-job |
Description | string | 否 | 任務描述 | test |
RouteStrategy | integer | 否 | 路由策略:
| 1 |
Parameters | string | 否 | 任務參數 | test |
MaxConcurrency | integer | 否 | 任務并發數 說明
同一個任務同一時間允許運行的最大實例個數,1 表示不允許重復執行。如果超過并發數,會跳過當前調度。
| 1 |
MaxAttempt | integer | 否 | 任務失敗重試次數 | 3 |
AttemptInterval | integer | 否 | 任務失敗重試間隔 | 3 |
JobHandler | string | 否 | jobhandler 名稱 | testJobVoidHandler |
TimeType | integer | 否 | 時間類型,目前支持以下幾種類型:
| 1 |
TimeExpression | string | 否 | 時間表達式,根據選擇的時間類型設置時間表達式。
| 0 0 4 ? * Mon/1 |
Calendar | string | 否 | 自定義日歷 | workday |
Priority | integer | 否 | 任務執行優先級。目前支持以下幾種配置:
| 10 |
StartTime | long | 否 | 調度開始時間 | 1716902187 |
Timezone | string | 否 | 時區 說明
默認使用 schedulerx 服務器所在時區
| Hongkong |
NoticeConfig | object | 否 | 通知配置 | |
TimeoutEnable | boolean | 否 | 超時報警開關。取值如下:
| true |
Timeout | long | 否 | 任務執行超時時間,單位為秒。 | 90 |
TimeoutKillEnable | boolean | 否 | 超時終止本次觸發開關。取值如下:
| true |
SuccessNotice | boolean | 否 | 成功通知開關。取值如下:
| true |
FailEnable | boolean | 否 | 失敗報警開關。取值如下:
| true |
FailLimitTimes | integer | 否 | 連續失敗次數。 說明
只有連續失敗超過配置次數才會收到報警。
| true |
MissWorkerEnable | boolean | 否 | 是否開啟無可用機器告警。
| true |
SendChannel | string | 否 | 通知渠道,取值如下:
說明
配置多個通知渠道請用逗號分割
| webhook,sms,mail,phone |
NoticeContacts | array<object> | 否 | 通知聯系人配置 | |
object | 否 | |||
ContactType | integer | 否 | 聯系人類型 說明
默認配置: 1
| 1 |
Name | string | 否 | 聯系人名稱 | xiaoming |
返回參數
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "Parameter error: content is null.",
"RequestId": "3808cf26-dde2-4286-8503-b0a2cd4065a7",
"Success": true
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | Parameter error: %s. | 參數錯誤: %s |
401 | IllegalRequest | IllegalRequest: %s. | 非法請求:%s |
403 | NoPermission | No permission to perform this operation: %s. | 沒有權限去執行該操作:%s |
404 | NotFound | Not found: %s. | 資源不存在:%s |
500 | InternalError | InternalError: %s. | 系統內部錯誤:%s |
訪問錯誤中心查看更多錯誤碼。