任务操作

EntranceRestfulApi 类

处理任务请求

接口地址:/api/rest_j/v1/entrance/execute

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

execute函数处理的是用户提交执行任务的请求

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
json json body true object

响应状态:

状态码 说明 schema
200 OK Message
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

提交execute函数

接口地址:/api/rest_j/v1/entrance/submit

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

提交execute函数

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
Submit json body true Submit Submit

响应状态:

状态码 说明 schema
200 OK Message
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

结束任务

接口地址:/api/rest_j/v1/entrance/{id}/kill

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

kill任务

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
id ID path false string
taskID 任务ID query false string

响应状态:

状态码 说明 schema
200 OK Message
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

结束Jobs

接口地址:/api/rest_j/v1/entrance/{id}/killJobs

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

结束Jobs

请求示例:

1. {
2. "taskIDList": [],
3. "idList": []
4. }

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
id id请求路径生成 path true string
taskIDList 任务ID集合 false String String
idList ID集合 false String String

响应状态:

状态码 说明 schema
200 OK Message
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "method": "/api/entrance/#id/killJobs",
3. "status": 0,
4. "message": "success",
5. "data": {
6. "messages": [{
7. "method": "",
8. "status": 0,
9. "message": "",
10. "data": {
11. "execID": ""
12. }
13. }]
14. }
15. }

任务日志

接口地址:/api/rest_j/v1/entrance/{id}/log

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

获取任务日志

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
id 任务ID path false string

响应状态:

状态码 说明 schema
200 OK Message
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

暂停任务

接口地址:/api/rest_j/v1/entrance/{id}/pause

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

暂停任务

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
id 任务ID path false string

响应状态:

状态码 说明 schema
200 OK Message
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

任务进展

接口地址:/api/rest_j/v1/entrance/{id}/progress

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

任务进展

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
id 任务ID path false string

响应状态:

状态码 说明 schema
200 OK Message
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

资源进展

接口地址:/api/rest_j/v1/entrance/{id}/progressWithResource

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

资源进展

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
id ID path false string

响应状态:

状态码 说明 schema
200 OK Message
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

任务状态

接口地址:/api/rest_j/v1/entrance/{id}/status

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

任务状态

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
id ID path false string
taskID 任务ID query false string

响应状态:

状态码 说明 schema
200 OK Message
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }