Skip to main content
版本:1.3.0

任务操作

EntranceRestfulApi 类

处理任务请求

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

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

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

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
jsonjsonbodytrueobject

响应状态:

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

响应参数:

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

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

提交execute函数

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

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

提交execute函数

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
SubmitjsonbodytrueSubmitSubmit

响应状态:

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

响应参数:

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

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

结束任务

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

请求方式:GET

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

响应数据类型:*/*

接口描述:

kill任务

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
idIDpathfalsestring
taskID任务IDqueryfalsestring

响应状态:

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

响应参数:

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

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

结束Jobs

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

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

结束Jobs

请求示例:

{
"taskIDList": [],
"idList": []
}

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
idid请求路径生成pathtruestring
taskIDList任务ID集合falseStringString
idListID集合falseStringString

响应状态:

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

响应参数:

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

响应示例:

{
"method": "/api/entrance/#id/killJobs",
"status": 0,
"message": "success",
"data": {
"messages": [{
"method": "",
"status": 0,
"message": "",
"data": {
"execID": ""
}
}]
}
}

任务日志

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

请求方式:GET

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

响应数据类型:*/*

接口描述:

获取任务日志

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id任务IDpathfalsestring

响应状态:

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

响应参数:

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

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

暂停任务

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

请求方式:GET

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

响应数据类型:*/*

接口描述:

暂停任务

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id任务IDpathfalsestring

响应状态:

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

响应参数:

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

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

任务进展

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

请求方式:GET

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

响应数据类型:*/*

接口描述:

任务进展

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id任务IDpathfalsestring

响应状态:

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

响应参数:

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

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

资源进展

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

请求方式:GET

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

响应数据类型:*/*

接口描述:

资源进展

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
idIDpathfalsestring

响应状态:

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

响应参数:

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

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

任务状态

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

请求方式:GET

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

响应数据类型:*/*

接口描述:

任务状态

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
idIDpathfalsestring
taskID任务IDqueryfalsestring

响应状态:

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

响应参数:

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

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}