創(chuàng)建任務(wù)。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
當(dāng)前API暫無(wú)授權(quán)信息透出。
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClusterId | string | 是 | 集群 ID | xxljob-b6ec1xxxx |
AppName | string | 是 | 應(yīng)用名稱 | test-app |
Name | string | 是 | 任務(wù)名稱 | test-job |
Description | string | 否 | 任務(wù)描述 | test |
JobType | string | 是 | 任務(wù)類型 | xxljob |
RouteStrategy | integer | 是 | 路由策略。具體取值如下:
| 1 |
Parameters | string | 否 | 任務(wù)參數(shù) | test |
MaxConcurrency | integer | 否 | 最大并發(fā)數(shù) | 1 |
MaxAttempt | integer | 否 | 錯(cuò)誤最大重試次數(shù),根據(jù)業(yè)務(wù)需求填寫 | 3 |
AttemptInterval | integer | 否 | 錯(cuò)誤重試間隔,單位 s,默認(rèn)值為 30。 | 3 |
JobHandler | string | 是 | jobhandler 名稱 | testJobVoidHandler |
TimeType | integer | 是 | 時(shí)間類型:
| -1 |
TimeExpression | string | 否 | 時(shí)間表達(dá)式,根據(jù)選擇的時(shí)間類型設(shè)置時(shí)間表達(dá)式。
| 0 0 4 ? * Mon/1 |
Calendar | string | 否 | cron 類型可以選擇填寫自定義日歷。 | workday |
Timezone | string | 否 | 時(shí)區(qū) | GMT+8 |
StartTime | long | 否 | 開始時(shí)間 | 1701310327000 |
Priority | integer | 否 | 優(yōu)先級(jí):
| 5 |
NoticeConfig | object | 否 | 通知配置 | |
TimeoutEnable | boolean | 否 | 超時(shí)報(bào)警開關(guān)。取值如下:
| true |
Timeout | long | 否 | 超時(shí)時(shí)間,單位秒。 | 30 |
TimeoutKillEnable | boolean | 否 | 超時(shí)終止開關(guān)。取值如下:
| true |
SuccessNotice | boolean | 否 | 成功通知開關(guān)。取值如下:
| true |
FailEnable | boolean | 否 | 失敗報(bào)警開關(guān)。取值如下:
| true |
FailLimitTimes | integer | 否 | 連續(xù)失敗次數(shù)。 說(shuō)明
只有連續(xù)失敗超過(guò)配置次數(shù)才會(huì)收到報(bào)警。
| 1 |
MissWorkerEnable | boolean | 否 | 是否開啟無(wú)可用機(jī)器報(bào)警。
| true |
SendChannel | string | 否 | 通知渠道,取值如下:
說(shuō)明
配置多個(gè)通知渠道請(qǐng)用逗號(hào)分割
| |
NoticeContacts | array<object> | 否 | 通知聯(lián)系人配置 | |
object | 否 | . | ||
ContactType | integer | 否 | 聯(lián)系人類型 說(shuō)明
默認(rèn)配置: 1
| 1 |
Name | string | 否 | 聯(lián)系人名稱 | xiaoming |
Status | integer | 否 | 任務(wù)狀態(tài),默認(rèn)為啟用狀態(tài)。
| 1 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "Parameter error: content is null.",
"RequestId": "3835AA29-2298-5434-BC53-9CC377CDFD2C",
"Success": true,
"Data": {
"JobId": 74
}
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | Parameter error: %s. | 參數(shù)錯(cuò)誤: %s |
401 | IllegalRequest | IllegalRequest: %s. | 非法請(qǐng)求:%s |
403 | NoPermission | No permission to perform this operation: %s. | 沒(méi)有權(quán)限去執(zhí)行該操作:%s |
404 | NotFound | Not found: %s. | 資源不存在:%s |
500 | InternalError | InternalError: %s. | 系統(tǒng)內(nèi)部錯(cuò)誤:%s |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。