Exports job information in bulk.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClusterId |
string |
Yes |
The cluster ID. |
xxljob-b6ec1xxxx |
| AppName |
string |
Yes |
The application name. |
test-app |
| JobIds |
array |
No |
The list of job IDs. |
|
|
integer |
No |
The job ID. |
74 |
|
| ExportJobType |
integer |
No |
The export job type. The default value is 1. |
1 |
Response elements
|
Element |
Type |
Description |
Example |
|
string |
The exported job details, in JSON format. |
{ "kind": "SchedulerXJobs", "type": "JSON", "version": "2.0", "content": [ { "appName": "test-app", "groupId": "test-app", "description": "Test App", "jobConfigInfo": [ { "jobHandler": "jobDemoHandler", "dataOffset": 0, "executeMode": "standalone", "monitorConfigInfo": { "alarmType": "CustomContacts", "failLimitTimes": 1, "failEnable": true, "failRate": 100, "timeoutKillEnable": false, "missWorkerEnable": false, "sendChannel": "webhook,mail", "timeoutEnable": true, "timeout": 300, "daysOfDeadline": 0, "successNotice": false }, "attemptInterval": 30, "cleanMode": "{\"cleanMode\":\"NUM_ONLY\",\"totalRemain\":300}", "description": "", "routeStrategy": 1, "userName": "1827811800526502", "userId": "1827811800526502", "content": "{\"jobHandler\":\"helloworld\"}", "maxConcurrency": 1, "maxAttempt": 0, "name": "Specified IP test", "xattrs": "", "jobType": "xxljob", "contentType": 1, "parameters": "123", "timeConfig": { "dataOffset": 0, "timeType": 1, "paramMap": { }, "timeExpression": "0 * * * * ?" }, "contactInfoList": [ { "name": "xiaoming", "contactType": 1 } ], "status": 1 } ] } ] } |
Examples
Success response
JSON format
"{\n \"kind\": \"SchedulerXJobs\",\n \"type\": \"JSON\",\n \"version\": \"2.0\",\n \"content\": [\n {\n \"appName\": \"test-app\",\n \"groupId\": \"test-app\",\n \"description\": \"Test App\",\n \"jobConfigInfo\": [\n {\n \"jobHandler\": \"jobDemoHandler\",\n \"dataOffset\": 0,\n \"executeMode\": \"standalone\",\n \"monitorConfigInfo\": {\n \"alarmType\": \"CustomContacts\",\n \"failLimitTimes\": 1,\n \"failEnable\": true,\n \"failRate\": 100,\n \"timeoutKillEnable\": false,\n \"missWorkerEnable\": false,\n \"sendChannel\": \"webhook,mail\",\n \"timeoutEnable\": true,\n \"timeout\": 300,\n \"daysOfDeadline\": 0,\n \"successNotice\": false\n },\n \"attemptInterval\": 30,\n \"cleanMode\": \"{\\\"cleanMode\\\":\\\"NUM_ONLY\\\",\\\"totalRemain\\\":300}\",\n \"description\": \"\",\n \"routeStrategy\": 1,\n \"userName\": \"1827811800526502\",\n \"userId\": \"1827811800526502\",\n \"content\": \"{\\\"jobHandler\\\":\\\"helloworld\\\"}\",\n \"maxConcurrency\": 1,\n \"maxAttempt\": 0,\n \"name\": \"Specified IP test\",\n \"xattrs\": \"\",\n \"jobType\": \"xxljob\",\n \"contentType\": 1,\n \"parameters\": \"123\",\n \"timeConfig\": {\n \"dataOffset\": 0,\n \"timeType\": 1,\n \"paramMap\": {\n \n },\n \"timeExpression\": \"0 * * * * ?\"\n },\n \"contactInfoList\": [\n {\n \"name\": \"xiaoming\",\n \"contactType\": 1\n }\n ],\n \"status\": 1\n }\n ]\n }\n ]\n}\n"Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter | Parameter error: %s. | Parameter error: %s |
| 401 | IllegalRequest | IllegalRequest: %s. | Illegal request:%s |
| 500 | InternalError | InternalError: %s. | System Internal Error: %s |
| 403 | NoPermission | No permission to perform this operation: %s. | No permission to perform this operation: %s |
| 404 | NotFound | Not found: %s. | The resource does not exist: %s |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.