Skip to main content
版本:1.6.0

管理台首页API

QueryRestfulApi 类

管理员验证

接口地址:/api/rest_j/v1/jobhistory/governanceStationAdmin

请求方式:GET

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

响应数据类型:*/*

接口描述:

用来验证是否为管理员,如果是则返回true不是则false

请求参数:

暂无

响应状态:

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

响应参数:

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

响应示例:

{
data: {solution: null, admin: true}
message: "OK"
method: "/api/jobhistory/governanceStationAdmin"
status: 0
}

全局历史

接口地址:/api/rest_j/v1/jobhistory/list

请求方式:GET

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

响应数据类型:*/*

接口描述:

根据条件获取全局历史数据列表默认获取全部

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
creator创建者queryfalsestring
endDate结束时间queryfalseinteger(int64)
executeApplicationName操作人queryfalsestring
isAdminView是否为管理员模式或者普通模式queryfalseboolean
pageSize页面数量queryfalseref
proxyUser代理用户queryfalsestring
startDate开始时间queryfalseinteger(int64)
status结束时间queryfalsestring
taskIDIDqueryfalseinteger(int64)
tpageNow页码queryfalseref
pageNowpageNowqueryfalseinteger(int32)

响应状态:

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

响应参数:

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

响应示例:

{
{
"method": "/api/jobhistory/list",
"status": 0,
"message": "OK",
"data": {
"solution": null,
"totalPage": 90,
"tasks": [{
"taskID": ,
"instance": ",
"execId": "",
"umUser": "",
"engineInstance": null,
"executionCode": "",
"progress": "",
"logPath": "",
"resultLocation": "",
"status": "",
"createdTime": ,
"updatedTime": ,
"engineType": "",
"errCode": 0,
"errDesc": "",
"executeApplicationName": "",
"requestApplicationName": "",
"runType": "datachecker",
"paramsJson": "",
"costTime": 1000,
"strongerExecId": "",
"sourceJson": "",
"sourceTailor": "",
"engineStartTime": null,
"labels": [],
"canRetry": ,
"subJobs":
}]
}
}
}

获取未完成任务列表

接口地址:/api/rest_j/v1/jobhistory/listundone

请求方式:GET

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

响应数据类型:*/*

接口描述:

获取未完成任务列表

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
creatorcreatorqueryfalsestring
endDate结束时间queryfalseinteger(int64)
engineTypeengineTypequeryfalsestring
pageNowpageNowqueryfalseref
pageSizepageSizequeryfalseref
startDate开始时间queryfalseref
startTaskIDstartTaskIDqueryfalseinteger(int64)
statusstatusqueryfalsestring

响应状态:

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

响应参数:

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

响应示例:

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

job任务详细记录

接口地址:/api/rest_j/v1/jobhistory/{id}/get

请求方式:GET

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

响应数据类型:*/*

接口描述:

job任务详细记录

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id历史记录Idqueryfalseinteger(int64)

响应状态:

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

响应参数:

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

响应示例:

{
"method": "/api/jobhistory/1928730/get",
"status": 0,
"message": "OK",
"data": {
"task": {
"taskID": ,
"instance": "",
"execId": "",
"umUser": "",
"engineInstance": "",
"executionCode": "",
"progress": "",
"logPath": "",
"resultLocation": "",
"status": "",
"createdTime":,
"updatedTime": ,
"engineType": "",
"errCode": ,
"errDesc": "",
"executeApplicationName": "",
"requestApplicationName": "",
"runType": "hql",
"paramsJson": "",
"costTime": ,
"strongerExecId": "",
"sourceJson": "",
"sourceTailor": "",
"engineStartTime": null,
"labels": [""],
"canRetry": false,
"subJobs": null
}
}
}