獲取任務(wù)列表。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
當(dāng)前API暫無授權(quán)信息透出。
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClusterId | string | 是 | 集群 | xxljob-b6ec1xxxx |
AppName | string | 是 | 應(yīng)用名 | test-app |
Status | string | 否 | 狀態(tài) | 0 |
JobId | long | 否 | 任務(wù) ID | 10 |
JobName | string | 否 | 任務(wù)名 | job01 |
Description | string | 否 | 描述信息 | job01單機(jī)任務(wù) |
JobHandler | string | 否 | jobhandler 名稱 | jobDemoHandler |
PageNum | integer | 否 | 頁數(shù) | 1 |
PageSize | integer | 否 | 每頁數(shù) | 20 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "Parameter error: content is null.",
"RequestId": "1DF6732E-15D8-5E1F-95E3-C10077F556B5",
"Success": true,
"Data": {
"Records": [
{
"JobId": 74,
"Name": "job01",
"Description": "job01單機(jī)任務(wù)",
"JobType": "xxljob",
"Status": 1,
"Parameters": "name=10",
"MaxConcurrency": 100,
"MaxAttempt": 5,
"AttemptInterval": 30,
"JobHandler": "jobDemoHandler",
"Priority": 1,
"TimeType": 1,
"TimeExpression": "0 0 12 * * ?",
"TimeZone": "Hongkong",
"Calendar": "work-day",
"DataOffset": 3,
"CleanMode": "{\"cleanMode\":\"NUM_ONLY\",\"totalRemain\":300}",
"Creator": "1963096506470832",
"Updater": "1963096506470832",
"Xattrs": "暫無",
"NoticeConfig": "{\"failLimitTimes\":1,\"failEnable\":true,\"timeoutKillEnable\":false,\"missWorkerEnable\":true,\"timeoutEnable\":true,\"sendChannel\":\"\",\"timeout\":300,\"successNotice\":false}",
"NoticeContacts": "[{\"contactType\":1,\"name\":\"恰橙\"}]",
"RouteStrategy": 1,
"AppName": "test-app",
"Timezone": "HangKong",
"ExecutorBlockStrategy": "",
"LastExecuteEndTime": "",
"LastExecuteStatus": 0,
"CurrentExecuteStatus": 3
}
],
"Total": 65,
"PageNumber": 1,
"PageSize": 20
}
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | Parameter error: %s. | 參數(shù)錯(cuò)誤: %s |
401 | IllegalRequest | IllegalRequest: %s. | 非法請求:%s |
403 | NoPermission | No permission to perform this operation: %s. | 沒有權(quán)限去執(zhí)行該操作:%s |
404 | NotFound | Not found: %s. | 資源不存在:%s |
500 | InternalError | InternalError: %s. | 系統(tǒng)內(nèi)部錯(cuò)誤:%s |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-11-29 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |